GraphCoordinateSystem

Abstract Value Members

implicit abstract def dimension: Int

Dimension of the coordinate system

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def coordinateOf(id: Int): Option[CoordType]

Retrieve the embedded coordinate given a node ID.
Retrieve the embedded coordinate given a node ID.
returns
Embedded coordinate
def distanceBetween(source: Int, destination: Int): Double

Query the embedded distance given two node IDs.
Query the embedded distance given two node IDs.
source
ID of the source node
destination
ID of the destination node
returns
Estimated distance between source and destination
def embed(distances: DistanceStore, landmarkSet: Set[Int], primaries: Set[Int]): Unit

Java API for embed.
Java API for embed.
If you would like to use random selection of primary landmarks, set "primaries" to null.
All work done will be forwarded to the Scala version of embed. This method simply converts data structures to the Scala equivalent before passing it along.
landmarkSet
A set of landmark IDs
primaries
Contains IDs of primary landmarks to embed - pass null for default
def embed(distances: DistanceStore, landmarkSet: Set[Int], primaries: Option[Set[Int]] = None): Unit

Embeds a set of distances into the coordinate system.
Embeds a set of distances into the coordinate system.
Embeds a set of distances into the coordinate system - all work is forwarded to embedLandmarks and embedNonLandmark.
distances
DistanceStore implementation containing distance values to embed
landmarkSet
A set of landmark IDs
primaries
Optional parameter denoting primary landmarks to embed first
def embedLandmarks(landmarkSet: Set[Int], primaries: Set[Int])(implicit store: DistanceStore): Unit

Java API for embedLandmarks.
Java API for embedLandmarks.
If you would like to use random selection of primary landmarks, set "primaries" to null.
All work done will be forwarded to the Scala version of embedLandmarks. This method simply converts data structures to the Scala equivalent before passing it along.
landmarkSet
A set of landmark IDs
primaries
Contains IDs of primary landmarks to embed - pass null for default
store
DistanceStore implementation containing distance values to embed
def embedLandmarks(landmarkSet: Set[Int], primaries: Option[Set[Int]] = None)(implicit store: DistanceStore): Unit

Embed the landmarks into the coordinate system.
Embed the landmarks into the coordinate system.
Embed both primary and non-primary landmarks into the coordinate system. This function should only be called once per instantiation, enforced by the LANDMARKS_EMBEDDED flag.
Primary landmarks by default are chosen randomly. The number of such primary landmarks is set by default at 16. This value can be overridden in application.conf via gcs.embed.primary-landmarks.
If the primaries parameter is passed in, it will override the configuration files.
landmarkSet
A set of landmark IDs
primaries
Optional parameter denoting primary landmarks to embed first
store
DistanceStore implementation containing distance values to embed
def embedNonLandmark(id: Int)(implicit store: DistanceStore): CoordType

Embeds non-landmark into the coordinate system.
Embeds non-landmark into the coordinate system.
Embeds a non-landmark into the coordinate system by randomly selecting X amount of "neighbor" landmarks to align against. By default X is set to 16. This can be overridden via config with gcs.embed.neighbors.
id
ID of the node to embed
store
DistanceStore implementation containing distance values to embed
returns
coordinates of the embedded non-landmark
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def load(filename: String): Unit

Loads a set of coordinates from a given file.
Loads a set of coordinates from a given file.
File should be formatted such that each row represents the embedding of a single node. The format for each row should look like (using the Array[Double] view):
```
[L/N if (non-)landmark] [Node ID] [Coordinate 1] ... [Coordinate N]
```
filename
Path of the file containing the formatted coordinates.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def query(source: Int, destination: Int): Double

Query the embedded distance given two node IDs.
Query the embedded distance given two node IDs.
source
ID of the source node
destination
ID of the destination node
returns
Estimated distance between source and destination
def save(filename: String): Unit

Saves the sand landmark and node embeddings of the coordinate system.
Saves the sand landmark and node embeddings of the coordinate system.
File saved will be formatted as (using the Array[Double] view):
```
[L/N if (non-)landmark] [Node ID] [Coordinate 1] ... [Coordinate N]
```
filename
Path of the file to save the coordinates into.
def storeCoordinate(id: Int, coordinate: CoordType, isLandmark: Boolean): Unit
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

trait GraphCoordinateSystem[CoordType] extends Serializable

Abstract Value Members

implicit abstract def dimension: Int

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def coordinateOf(id: Int): Option[CoordType]

def distanceBetween(source: Int, destination: Int): Double

def embed(distances: DistanceStore, landmarkSet: Set[Int], primaries: Set[Int]): Unit

def embed(distances: DistanceStore, landmarkSet: Set[Int], primaries: Option[Set[Int]] = None): Unit

def embedLandmarks(landmarkSet: Set[Int], primaries: Set[Int])(implicit store: DistanceStore): Unit

def embedLandmarks(landmarkSet: Set[Int], primaries: Option[Set[Int]] = None)(implicit store: DistanceStore): Unit

def embedNonLandmark(id: Int)(implicit store: DistanceStore): CoordType

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def load(filename: String): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def query(source: Int, destination: Int): Double

def save(filename: String): Unit

def storeCoordinate(id: Int, coordinate: CoordType, isLandmark: Boolean): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped