com.signalcollect.interfaces.Storage.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of signal-collect_2.11 Show documentation

A framework for parallel and distributed graph processing.

The newest version!

/*
 *  @author Daniel Strebel
 *
 *  Copyright 2011 University of Zurich
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package com.signalcollect.interfaces

import com.signalcollect.Vertex

/**
 * High level interface to abstract all vertex storage related implementations
 */
trait Storage[@specialized(Int, Long) Id, Signal] {
  def vertices: VertexStore[Id, Signal]
  def toSignal: VertexStore[Id, Signal] //collection of all vertices that need to signal
  def toCollect: VertexStore[Id, Signal] //collection of all vertices that need to collect
  def updateStateOfVertex(vertex: Vertex[Id, _, Id, Signal]): Unit
  def close(): Unit
}

/**
 * Stores vertices and makes them retrievable through their associated id.
 */
trait VertexStore[@specialized(Int, Long) Id, Signal] {
  def get(id: Id): Vertex[Id, _, Id, Signal]
  def put(vertex: Vertex[Id, _, Id, Signal]): Boolean
  def updateStateOfVertex(vertex: Vertex[Id, _, Id, Signal]): Unit
  def remove(id: Id): Unit
  def isEmpty: Boolean
  def size: Long
  def stream: Stream[Vertex[Id, _, Id, Signal]]
  def foreach(f: Vertex[Id, _, Id, Signal] => Unit): Unit
  def process(p: Vertex[Id, _, Id, Signal] => Unit, numberOfVertices: Option[Int] = None): Int
  def processWithCondition(p: Vertex[Id, _, Id, Signal] => Unit, breakCondition: () => Boolean): Int
  def close(): Unit
}