Class/Object

libcog.fields

StickTensor

Related Docs: object StickTensor | package fields

Permalink

class StickTensor extends libcog.Complex

A stick tensor in 2 dimensions, encoded as a complex number.

Because orientation extends only from 0 to Pi while phase of a complex number extends from 0 to 2 Pi, we *define* orientation to be half the phase of the complex number. This means when creating the stick tensor from a given orientation and magnitude, the orientation must be doubled.

returns

A stick tensor, represented as a complex number.

Linear Supertypes
cogx.cogmath.algebra.complex.Complex, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StickTensor
  2. Complex
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StickTensor(stickness: Float, orientation: Float)

    Permalink

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: Float): cogx.cogmath.algebra.complex.Complex

    Permalink

    this * that

    this * that

    Definition Classes
    Complex

  4. def *(that: cogx.cogmath.algebra.complex.Complex): cogx.cogmath.algebra.complex.Complex

    Permalink

    this * that

    this * that

    Definition Classes
    Complex

  5. def +(that: Float): cogx.cogmath.algebra.complex.Complex

    Permalink

    this + that

    this + that

    Definition Classes
    Complex

  6. def +(that: cogx.cogmath.algebra.complex.Complex): cogx.cogmath.algebra.complex.Complex

    Permalink

    this + that

    this + that

    Definition Classes
    Complex

  7. def -(that: Float): cogx.cogmath.algebra.complex.Complex

    Permalink

    this - that

    this - that

    Definition Classes
    Complex

  8. def -(that: cogx.cogmath.algebra.complex.Complex): cogx.cogmath.algebra.complex.Complex

    Permalink

    this - that

    this - that

    Definition Classes
    Complex

  9. def /(that: cogx.cogmath.algebra.complex.Complex): cogx.cogmath.algebra.complex.Complex

    Permalink

    this / that

    this / that

    Definition Classes
    Complex

  10. def /(that: Float): cogx.cogmath.algebra.complex.Complex

    Permalink

    this / that

    this / that

    Definition Classes
    Complex

  11. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  13. def canEqual(other: Any): Boolean

    Permalink

    Helper for equals.

    Helper for equals.

    Definition Classes
    Complex

  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. def conjugate: cogx.cogmath.algebra.complex.Complex

    Permalink

    Get the complex conjugate of this.

    Get the complex conjugate of this.

    Definition Classes
    Complex

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

    Permalink
    Definition Classes
    AnyRef

  17. def equals(other: Any): Boolean

    Permalink

    Test this and other for deep equality.

    Test this and other for deep equality.

    Definition Classes
    Complex → AnyRef → Any

  18. def exp: cogx.cogmath.algebra.complex.Complex

    Permalink

    e ^ this

    e ^ this

    Definition Classes
    Complex

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  21. def getData: ComplexArray

    Permalink

    Get the data in the tensor, flattened to a linear array.

    Get the data in the tensor, flattened to a linear array.

    Attributes
    protected
    Definition Classes
    Complex

  22. def hashCode(): Int

    Permalink

    Required because of overriding equals.

    Required because of overriding equals.

    Definition Classes
    Complex → AnyRef → Any

  23. val imaginary: Float

    Permalink
    Definition Classes
    Complex

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. def magnitude: Float

    Permalink

    The length of the complex number.

    The length of the complex number.

    Definition Classes
    Complex

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. def normSq: Float

    Permalink

    The norm of the complex number.

    The norm of the complex number.

    Definition Classes
    Complex

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. val orientation: Float

    Permalink

  31. def phase: Float

    Permalink

    The phase (angle) in radians.

    The phase (angle) in radians.

    This is a number in the range (-Pi, Pi].

    Definition Classes
    Complex

  32. def power(exponent: Int): cogx.cogmath.algebra.complex.Complex

    Permalink

    this ^ exponent

    this ^ exponent

    Definition Classes
    Complex

  33. def print: Unit

    Permalink

    Print out a complex number for debugging.

    Print out a complex number for debugging.

    Definition Classes
    Complex

  34. val real: Float

    Permalink
    Definition Classes
    Complex

  35. def reciprocal: cogx.cogmath.algebra.complex.Complex

    Permalink

    1/this

    1/this

    Definition Classes
    Complex

  36. val stickness: Float

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  38. def toString(): String

    Permalink

    Format the complex number as a String.

    Format the complex number as a String.

    Definition Classes
    Complex → AnyRef → Any

  39. def unary_-(): cogx.cogmath.algebra.complex.Complex

    Permalink

    -this

    -this

    Definition Classes
    Complex

  40. final def wait(): Unit

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

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

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

  42. final def wait(arg0: Long): Unit

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

  43. def ~==(that: cogx.cogmath.algebra.complex.Complex): Boolean

    Permalink
    Definition Classes
    Complex

Inherited from cogx.cogmath.algebra.complex.Complex

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped