Trait

cogx.platform.cpumemory.readerwriter

MatrixFieldReader

Related Doc: package readerwriter

Permalink

trait MatrixFieldReader extends FieldReader

The interface for reading a scalar field on the CPU.

Linear Supertypes
FieldReader, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MatrixFieldReader
  2. FieldReader
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val columns: Int

    Permalink

    "Columns" in the field; 1 for 0D fields.

    "Columns" in the field; 1 for 0D fields.

    Definition Classes
    FieldReader
  2. abstract def compareLinf(that: FieldReader): Float

    Permalink

    Compute the L-infinity norm on the difference of this and that.

    Compute the L-infinity norm on the difference of this and that.

    that

    AbstractFieldMemory to compare to this

    returns

    L-infinity error

    Definition Classes
    FieldReader
  3. abstract def fieldShape: cogmath.geometry.Shape

    Permalink

    Shape of the field.

    Shape of the field.

    Definition Classes
    FieldReader
  4. abstract def fieldType: types.FieldType

    Permalink

    Type of the field.

    Type of the field.

    Definition Classes
    FieldReader
  5. abstract val layers: Int

    Permalink

    "Layers" in the field; 1 for 2D, 1D, 0D fields.

    "Layers" in the field; 1 for 2D, 1D, 0D fields.

    Definition Classes
    FieldReader
  6. abstract def read(layer: Int, row: Int, col: Int, out: cogmath.algebra.real.Matrix): Unit

    Permalink

    Read the value at (layer, row, col) in a 3D matrix field into out.

  7. abstract def read(row: Int, col: Int, out: cogmath.algebra.real.Matrix): Unit

    Permalink

    Read the value at (row, col) in a 2D matrix field into out.

  8. abstract def read(col: Int, out: cogmath.algebra.real.Matrix): Unit

    Permalink

    Read the value at (col) in a 1D matrix field into out.

  9. abstract def read(out: cogmath.algebra.real.Matrix): Unit

    Permalink

    Read the single value in a 0D matrix field into out.

  10. abstract val rows: Int

    Permalink

    "Rows" in the field; 1 for 1D, 0D fields.

    "Rows" in the field; 1 for 1D, 0D fields.

    Definition Classes
    FieldReader
  11. abstract def tensorShape: cogmath.geometry.Shape

    Permalink

    Shape of the tensors in the field.

    Shape of the tensors in the field.

    Definition Classes
    FieldReader

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def approxEquals(that: FieldReader, maxError: Float = 0.001f): Boolean

    Permalink

    Test for approximate equality between this and that using L-infinity norm.

    Test for approximate equality between this and that using L-infinity norm.

    that

    AbstractFieldMemory to compare to this

    maxError

    Maximum L-infinity error value to consider equal

    returns

    true if L_inf(this, that) <= maxError

    Definition Classes
    FieldReader
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(that: FieldReader): Boolean

    Permalink

    Test for exact equality between this and that.

    Test for exact equality between this and that.

    that

    AbstractFieldMemory to compare to this

    returns

    true if every value in this and that is exactly equal

    Definition Classes
    FieldReader
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

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

Inherited from FieldReader

Inherited from AnyRef

Inherited from Any

Ungrouped