Trait/Object

com.cra.figaro.library.collection

Container

Related Docs: object Container | package collection

Permalink

trait Container[Index, Value] extends Process[Index, Value]

A Container is a Process with a defined sequence of indices.

Linear Supertypes
Process[Index, Value], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Container
  2. Process
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class IndexOutOfRangeException(index: Index) extends RuntimeException with Product with Serializable

    Permalink

    Thrown if the index does not have an element.

    Thrown if the index does not have an element.

    Definition Classes
    Process

Abstract Value Members

  1. abstract def generate(index: Index): Element[Value]

    Permalink

    Produce the element corresponding to the value of the process at the given index.

    Produce the element corresponding to the value of the process at the given index. This method can assume that the indices has already been range checked.

    Definition Classes
    Process
  2. abstract def generate(indices: List[Index]): Map[Index, Element[Value]]

    Permalink

    Produce the elements representing the value of the process at the given indices.

    Produce the elements representing the value of the process at the given indices. Ensures that any dependencies between the elements are represented. This method must be implemented by implementations of Process. The return value maps each provided index to the corresponding element. This method can assume that the indices has already been range checked.

    Definition Classes
    Process
  3. abstract val indices: Seq[Index]

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(that: Container[Index, Value]): Container[Index, Value]

    Permalink

    Returns a new container containing the elements of this container and the argument.

    Returns a new container containing the elements of this container and the argument. If an index is defined in both container, the element of the argument is used.

  4. def ++(that: Process[Index, Value]): Process[Index, Value]

    Permalink

    Returns a new process containing the elements of this process and the argument.

    Returns a new process containing the elements of this process and the argument. If an index is defined in both processes, the element of the argument is used.

    Definition Classes
    Process
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def aggregate[Value2](start: ⇒ Value2)(seqop: (Value2, Value) ⇒ Value2, combop: (Value2, Value2) ⇒ Value2)(implicit name: Name[Value2], collection: ElementCollection): Element[Value2]

    Permalink

    Aggregate the results of applying an operator to each element.

  7. def apply(indices: Traversable[Index]): Map[Index, Element[Value]]

    Permalink

    Get the elements representing the value of the process at the given indices.

    Get the elements representing the value of the process at the given indices. Throws IndexOutOfRangeException if any index has no value.

    Definition Classes
    Process
  8. def apply(index: Index): Element[Value]

    Permalink

    Get an element representing the value of the process at the given index.

    Get an element representing the value of the process at the given index. Throws IndexOutOfRangeException if the index has no value.

    This apply method is cached, so calling process(index) always returns the same element.

    Definition Classes
    Process
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def chain[Value2](f: (Value) ⇒ Element[Value2]): Container[Index, Value2]

    Permalink

    Chain every value in this container through the given function, returning a new container.

    Chain every value in this container through the given function, returning a new container.

    Definition Classes
    ContainerProcess
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def count(f: (Value) ⇒ Boolean)(implicit name: Name[Int], collection: ElementCollection): Element[Int]

    Permalink

    Returns an element representing the number of elements in the container whose values satisfy the predicate.

  13. def elements: Seq[Element[Value]]

    Permalink

    Return all the elements in this container as an ordinary Scala Seq.

    Return all the elements in this container as an ordinary Scala Seq. This method caches the elements, like apply, so the same elements will be returned every time.

  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def exists(pred: (Value) ⇒ Boolean)(implicit name: Name[Boolean], collection: ElementCollection): Element[Boolean]

    Permalink

    Returns an element representing whether the value of any element in the container satisfies the predicate.

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def findIndex(pred: (Value) ⇒ Boolean)(implicit name: Name[Option[Index]], collection: ElementCollection): Element[Option[Index]]

    Permalink

    Returns an element representing the optional index of the first element in the container whose value satisfies the predicate.

    Returns an element representing the optional index of the first element in the container whose value satisfies the predicate. The result has value None if no element is found.

  19. def flatMap[Value2](f: (Value) ⇒ Element[Value2]): Container[Index, Value2]

    Permalink

    Chain every value in this container through the given function, returning a new container.

    Chain every value in this container through the given function, returning a new container.

    Definition Classes
    ContainerProcess
  20. def foldLeft[Value2](start: Value2)(f: (Value2, Value) ⇒ Value2)(implicit name: Name[Value2], collection: ElementCollection): Element[Value2]

    Permalink

    Fold the values in this container through the given function.

  21. def foldRight[Value2](start: Value2)(f: (Value, Value2) ⇒ Value2)(implicit name: Name[Value2], collection: ElementCollection): Element[Value2]

    Permalink

    Fold the values in this container through the given function.

  22. def forall(pred: (Value) ⇒ Boolean)(implicit name: Name[Boolean], collection: ElementCollection): Element[Boolean]

    Permalink

    Returns an element representing whether the values of all elements in the container satisfy the predicate.

  23. def get(indices: Traversable[Index]): Map[Index, Element[Option[Value]]]

    Permalink

    Safely get the elements over optional values at all of the indices.

    Safely get the elements over optional values at all of the indices. Any index that is not in range will always have value None. Dependencies between elements for indices in range will be produced.

    Definition Classes
    Process
  24. def get(index: Index): Element[Option[Value]]

    Permalink

    Safely get an element over an optional value at the index.

    Safely get an element over an optional value at the index. If the index is in range, the value of the element will be Some(something). If the index is out of range, the value of the element will be None.

    Definition Classes
    Process
  25. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  28. def map[Value2](f: (Value) ⇒ Value2): Container[Index, Value2]

    Permalink

    Apply the given function to every value in this container, returning a new container.

    Apply the given function to every value in this container, returning a new container.

    Definition Classes
    ContainerProcess
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def randomElement(): Chain[Int, Value]

    Permalink

    Choose a random element from this container.

  33. def rangeCheck(index: Index): Boolean

    Permalink

    Check whether the given index has an element.

    Check whether the given index has an element.

    Definition Classes
    ContainerProcess
  34. def reduce(f: (Value, Value) ⇒ Value)(implicit name: Name[Value], collection: ElementCollection): Element[Value]

    Permalink

    Reduce the values in this container through the given function.

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

    Permalink
    Definition Classes
    AnyRef
  36. def toMap: Map[Index, Element[Value]]

    Permalink

    Convert this container into an ordinary Scala map.

  37. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Process[Index, Value]

Inherited from AnyRef

Inherited from Any

Ungrouped