scalax.collection.generic

GraphCompanion

trait GraphCompanion[+CC[N, E[X] <: EdgeLikeIn[X]] <: Graph[N, E[X]] with GraphLike[N, E[X], CC]] extends AnyRef

Methods common to Graph companion objects in the core module.

CC

the kind of type of the graph that is to become the companion class/trait of the object extending this trait.

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GraphCompanion
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Coll = CC[_, Nothing]

    Attributes
    protected
  2. abstract type Config <: GraphConfig

    Type of configuration required for a specific Graph companion.

  3. class GraphCanBuildFrom[N, E[X] <: EdgeLikeIn[X]] extends CanBuildFrom[Coll, Param[N, E], CC[N, E]]

Abstract Value Members

  1. abstract def defaultConfig: Config

    The default configuration to be used in absence of a user-supplied configuration.

  2. abstract def empty[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): CC[N, E]

    Creates an empty Graph instance.

  3. abstract def from[N, E[X] <: EdgeLikeIn[X]](nodes: Iterable[N] = Seq.empty[N], edges: Iterable[E[N]])(implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): CC[N, E]

    Produces a graph with a node set containing all nodes and edge ends in edges and with an edge set containing all edges but duplicates.

    Produces a graph with a node set containing all nodes and edge ends in edges and with an edge set containing all edges but duplicates. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    nodes

    the isolated and optionally any other non-isolated nodes to be included in the node set of the graph to be created.

    edges

    all edges to be included in the edge set of the graph to be created. Edge ends will be added to the node set automatically.

    returns

    A new graph instance containing nodes and all edge ends and edges.

  4. abstract def fromStream[N, E[X] <: EdgeLikeIn[X]](nodeStreams: Iterable[NodeInputStream[N]], nodes: Iterable[N], edgeStreams: Iterable[GenEdgeInputStream[N, E]], edges: Iterable[E[N]])(implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): CC[N, E]

    Creates a graph with nodes and edges read in from the input streams nodeStreams/edgeStreams and from nodes/edges.

    Creates a graph with nodes and edges read in from the input streams nodeStreams/edgeStreams and from nodes/edges.

    Node/edge streams are an efficient way to populate Graph instances from external resources such as a database. The user has to implement his input stream classes deriving them from NodeInputStream/EdgeInputStream.

    N

    type of nodes.

    E

    kind of type of edges.

    nodeStreams

    list of node input streams to be processed. All nodes read from any of these streams will be added to this graph. Note that only isolated nodes must be included in a stream or in nodes, non-isolated nodes are optional.

    nodes

    The isolated (and optionally any other) outer nodes that the node set of this graph is to be populated with. This parameter may be used as an alternative or in addition to nodeStreams.

    edgeStreams

    list of edge input streams, each with its own edge factory, to be processed. All edges and edge ends (nodes) read from any of these streams will be added to this graph.

    edges

    The outer edges that the edge set of this graph is to be populated with. Nodes being the end of any of these edges will be added to the node set. This parameter is meant be used as an alternative or in addition to edgeStreams.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (GraphCompanion[CC], B)

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to ArrowAssoc[GraphCompanion[CC]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. def apply[N, E[X] <: EdgeLikeIn[X]](elems: Param[N, E]*)(implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): CC[N, E]

    Creates a Graph with a node set built from all nodes in elems including edge ends and with an edge set containing all edges in elems.

    Creates a Graph with a node set built from all nodes in elems including edge ends and with an edge set containing all edges in elems. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    elems

    sequence of nodes and/or edges in an arbitrary order

    returns

    A new graph instance containing the nodes and edges derived from elems.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (GraphCompanion[CC]) ⇒ Boolean, msg: ⇒ Any): GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (GraphCompanion[CC]) ⇒ Boolean): GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. def fill[N, E[X] <: EdgeLikeIn[X]](nr: Int)(elem: ⇒ Param[N, E])(implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): CC[N, E]

    Produces a graph containing the results of some element computation a number of times.

    Produces a graph containing the results of some element computation a number of times. Duplicate exclusion takes place on the basis of values returned by hashCode of the supplied nodes and edges. The hash-code value of an edge is determined by its ends and optionally by other edge components such as weight or label. To include non-node edge components in the hash-code of an edge make use of any of the predefined key-weighted/key-labeled edges or mix ExtendedKey into your custom edge class.

    nr

    the number of elements to be contained in the graph.

    elem

    the element computation returning nodes or edges nr times.

    returns

    A graph that contains the results of nr evaluations of elem.

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

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

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. def newBuilder[N, E[X] <: EdgeLikeIn[X]](implicit edgeT: scala.reflect.api.JavaUniverse.TypeTag[E[N]], config: Config): Builder[Param[N, E], CC[N, E]]

  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (GraphCompanion[CC], B)

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to ArrowAssoc[GraphCompanion[CC]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphCompanion: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphCompanion: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to ArrowAssoc[GraphCompanion[CC]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphCompanion: ArrowAssoc[GraphCompanion[CC]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GraphCompanion[CC]

    Implicit information
    This member is added by an implicit conversion from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (graphCompanion: Ensuring[GraphCompanion[CC]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GraphCompanion[CC] to StringAdd

Inherited by implicit conversion any2stringfmt from GraphCompanion[CC] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GraphCompanion[CC] to ArrowAssoc[GraphCompanion[CC]]

Inherited by implicit conversion any2Ensuring from GraphCompanion[CC] to Ensuring[GraphCompanion[CC]]

Ungrouped