com.cra.figaro.library.collection

FixedSizeArray

class FixedSizeArray[Value] extends Container[Int, Value]

A Figaro collection representing a fixed number of elements. The indices into the collection are the integers from 0 to the size - 1.

Linear Supertypes
Container[Int, Value], Process[Int, Value], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FixedSizeArray
  2. Container
  3. Process
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FixedSizeArray(size: Int, generator: (Int) ⇒ Element[Value])

    size

    the number of elements in the collection

    generator

    a function to generate the elements in the collection, given the index

Type Members

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

    Thrown if the index does not have an element.

    Thrown if the index does not have an element.

    Definition Classes
    Process

Value Members

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

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

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

    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.

    Definition Classes
    Container
  4. def ++(that: Process[Int, Value]): Process[Int, Value]

    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

    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]

    Aggregate the results of applying an operator to each element.

    Aggregate the results of applying an operator to each element.

    Definition Classes
    Container
  7. def apply(indices: Traversable[Int]): Map[Int, Element[Value]]

    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: Int): Element[Value]

    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

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

    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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def concat[Index2](that: FixedSizeArray[Value]): FixedSizeArray[Value]

    Concatenate this container with another one.

    Concatenate this container with another one. In the result, all the elements in this container will precede all the elements in the other container. The result is an array containing all the elements of both containers.

  13. def count(f: (Value) ⇒ Boolean)(implicit name: Name[Int], collection: ElementCollection): Element[Int]

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

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

    Definition Classes
    Container
  14. def elements: Seq[Element[Value]]

    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.

    Definition Classes
    Container
  15. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    Container
  18. def finalize(): Unit

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

    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.

    Definition Classes
    Container
  20. def flatMap[Value2](f: (Value) ⇒ Element[Value2]): Container[Int, Value2]

    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
  21. def foldLeft[Value2](start: Value2)(f: (Value2, Value) ⇒ Value2)(implicit name: Name[Value2], collection: ElementCollection): Element[Value2]

    Fold the values in this container through the given function.

    Fold the values in this container through the given function.

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

    Fold the values in this container through the given function.

    Fold the values in this container through the given function.

    Definition Classes
    Container
  23. def forall(pred: (Value) ⇒ Boolean)(implicit name: Name[Boolean], collection: ElementCollection): Element[Boolean]

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

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

    Definition Classes
    Container
  24. def generate(indices: List[Int]): Map[Int, Element[Value]]

    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
    FixedSizeArrayProcess
  25. def generate(index: Int): Element[Value]

    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
    FixedSizeArrayProcess
  26. val generator: (Int) ⇒ Element[Value]

    a function to generate the elements in the collection, given the index

  27. def get(indices: Traversable[Int]): Map[Int, Element[Option[Value]]]

    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
  28. def get(index: Int): Element[Option[Value]]

    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
  29. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  31. val indices: Range

    Definition Classes
    FixedSizeArrayContainer
  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. def map[Value2](f: (Value) ⇒ Value2): Container[Int, Value2]

    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
  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. final def notify(): Unit

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

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

    Choose a random element from this container.

    Choose a random element from this container.

    Definition Classes
    Container
  38. def rangeCheck(index: Int): Boolean

    Check whether the given index has an element.

    Check whether the given index has an element.

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

    Reduce the values in this container through the given function.

    Reduce the values in this container through the given function.

    Definition Classes
    Container
  40. val size: Int

    the number of elements in the collection

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

    Definition Classes
    AnyRef
  42. def toMap: Map[Int, Element[Value]]

    Convert this container into an ordinary Scala map.

    Convert this container into an ordinary Scala map.

    Definition Classes
    Container
  43. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Container[Int, Value]

Inherited from Process[Int, Value]

Inherited from AnyRef

Inherited from Any

Ungrouped