scalation.linalgebra

VectorD

class VectorD extends PartiallyOrdered[VectorD] with Error with Serializable

The VectorD class stores and operates on Numeric Vectors of base type Double. It follows the framework of VectorN [T] and is provided for performance.

Linear Supertypes
Serializable, Serializable, Error, PartiallyOrdered[VectorD], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. VectorD
  2. Serializable
  3. Serializable
  4. Error
  5. PartiallyOrdered
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VectorD(u: VectorD)

    Construct a vector and assign values from vector u.

    Construct a vector and assign values from vector u.

    u

    the other vector

  2. new VectorD(u: Array[Double])

    Construct a vector from an array of values.

    Construct a vector from an array of values.

    u

    the array of values

  3. new VectorD(dim: Int, v: Array[Double] = null)

    dim

    the dimension/size of the vector

    v

    the 1D array used to store vector elements

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 *(m: Matrix): VectorD

    Multiply this 'row' vector by matrix m.

    Multiply this 'row' vector by matrix m.

    m

    the matrix to multiply by

  5. def *(s: Double): VectorD

    Multiply this vector by scalar s.

    Multiply this vector by scalar s.

    s

    the scalar to multiply by

  6. def *(b: VectorD): VectorD

    Multiply this vector by vector b.

    Multiply this vector by vector b.

    b

    the vector to multiply by

  7. def *=(s: Double): VectorD

    Multiply in-place this vector and scalar s.

    Multiply in-place this vector and scalar s.

    s

    the scalar to add

  8. def *=(b: VectorD): VectorD

    Multiply in-place this vector and vector b.

    Multiply in-place this vector and vector b.

    b

    the vector to add

  9. def +(s: (Double, Int)): VectorD

    Add this vector and scalar s.

    Add this vector and scalar s._1 only at position s._2.

    s

    the (scalar, position) to add

  10. def +(s: Double): VectorD

    Add this vector and scalar s.

    Add this vector and scalar s.

    s

    the scalar to add

  11. def +(b: VectorD): VectorD

    Add this vector and vector b.

    Add this vector and vector b.

    b

    the vector to add

  12. def ++(b: Double): VectorD

    Concatenate this vector and scalar b.

    Concatenate this vector and scalar b.

    b

    the scalar to be concatenated

  13. def ++(b: VectorD): VectorD

    Concatenate this vector and vector b.

    Concatenate this vector and vector b.

    b

    the vector to be concatenated

  14. def +=(s: Double): VectorD

    Add in-place this vector and scalar s.

    Add in-place this vector and scalar s.

    s

    the scalar to add

  15. def +=(b: VectorD): VectorD

    Add in-place this vector and vector b.

    Add in-place this vector and vector b.

    b

    the vector to add

  16. def -(s: (Double, Int)): VectorD

    From this vector subtract scalar s.

    From this vector subtract scalar s._1 only at position s._2.

    s

    the (scalar, position) to subtract

  17. def -(s: Double): VectorD

    From this vector subtract scalar s.

    From this vector subtract scalar s.

    s

    the scalar to subtract

  18. def -(b: VectorD): VectorD

    From this vector subtract vector b.

    From this vector subtract vector b.

    b

    the vector to subtract

  19. def -=(s: Double): VectorD

    From this vector subtract in-place scalar s.

    From this vector subtract in-place scalar s.

    s

    the scalar to add

  20. def -=(b: VectorD): VectorD

    From this vector subtract in-place vector b.

    From this vector subtract in-place vector b.

    b

    the vector to add

  21. def /(s: Double): VectorD

    Divide this vector by scalar s.

    Divide this vector by scalar s.

    s

    the scalar to divide by

  22. def /(b: VectorD): VectorD

    Divide this vector by vector b (element-by-element).

    Divide this vector by vector b (element-by-element).

    b

    the vector to divide by

  23. def /=(s: Double): VectorD

    Divide in-place this vector and scalar s.

    Divide in-place this vector and scalar s.

    s

    the scalar to add

  24. def /=(b: VectorD): VectorD

    Divide in-place this vector and vector b.

    Divide in-place this vector and vector b.

    b

    the vector to add

  25. def <[B >: VectorD](that: B)(implicit arg0: (B) ⇒ PartiallyOrdered[B]): Boolean

    Definition Classes
    PartiallyOrdered
  26. def <=[B >: VectorD](that: B)(implicit arg0: (B) ⇒ PartiallyOrdered[B]): Boolean

    Definition Classes
    PartiallyOrdered
  27. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  29. def >[B >: VectorD](that: B)(implicit arg0: (B) ⇒ PartiallyOrdered[B]): Boolean

    Definition Classes
    PartiallyOrdered
  30. def >=[B >: VectorD](that: B)(implicit arg0: (B) ⇒ PartiallyOrdered[B]): Boolean

    Definition Classes
    PartiallyOrdered
  31. def _oneAt(j: Int, size: Int = dim): VectorD

    Create a vector of the form (0, .

    Create a vector of the form (0, ... -1, ... 0) where the -1 is at position j.

    j

    the position to place the 1

    size

    the size of the vector (upper bound = size - 1)

  32. def abs: VectorD

    Return the vector that is the element-wise absolute value of this matrix.

  33. def apply(): Array[Double]

    Get this vector's entire array.

  34. def apply(r: Range): VectorD

    Get this vector's elements within the given range (vector slicing).

    Get this vector's elements within the given range (vector slicing).

    r

    the given range

  35. def apply(i: Int): Double

    Get this vector's element at the i-th index position.

    Get this vector's element at the i-th index position.

    i

    the given index

  36. def argmax(e: Int = dim): Int

    Find the argument maximum of this vector (index of maximum element).

    Find the argument maximum of this vector (index of maximum element).

    e

    the ending index (exclusive) for the search

  37. def argmaxPos(e: Int = dim): Int

    Return the argument maximum of this vector (-1 if its not positive).

    Return the argument maximum of this vector (-1 if its not positive).

    e

    the ending index (exclusive) for the search

  38. def argmin(e: Int = dim): Int

    Find the argument minimum of this vector (index of minimum element).

    Find the argument minimum of this vector (index of minimum element).

    e

    the ending index (exclusive) for the search

  39. def argminNeg(e: Int = dim): Int

    Return the argument minimum of this vector (-1 if its not negative).

    Return the argument minimum of this vector (-1 if its not negative).

    e

    the ending index (exclusive) for the search

  40. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  41. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  42. def contains(x: Double): Boolean

    Determine whether x is contained in this vector.

    Determine whether x is contained in this vector.

    x

    the element to be checked

  43. def countNeg: Int

    Count the number of strictly negative entries in this vector.

  44. def countPos: Int

    Count the number of strictly positive entries in this vector.

  45. def cumulate: VectorD

    Cumulate the values of this vector from left to right (e.

    Cumulate the values of this vector from left to right (e.g., create a cdf from a pmf). Example: (4, 2, 3, 1) --> (4, 6, 9, 10)

  46. val dim: Int

    the dimension/size of the vector

  47. def dot(b: VectorD): Double

    Compute the dot product (or inner product) of this vector with vector b.

    Compute the dot product (or inner product) of this vector with vector b.

    b

    the other vector

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

    Definition Classes
    AnyRef
  49. def equals(b: Any): Boolean

    Override equals to determine whether vector this equals vector b.

    Override equals to determine whether vector this equals vector b.

    b

    the vector to compare with this

    Definition Classes
    VectorD → AnyRef → Any
  50. def exists(pred: (Double) ⇒ Boolean): Boolean

    Determine whether the predicate pred holds for some element in this vector.

    Determine whether the predicate pred holds for some element in this vector.

    pred

    the predicate to test (e.g., "_ == 5.")

  51. def expand(more: Int = dim): VectorD

    Expand the size (dim) of this vector by 'more' elements.

  52. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  53. def firstNeg(e: Int = dim): Int

    Return the index of the first negative element in this vector (-1 otherwise).

    Return the index of the first negative element in this vector (-1 otherwise).

    e

    the ending index (exclusive) for the search

  54. def firstPos(e: Int = dim): Int

    Return the index of the first positive element in this vector (-1 otherwise).

    Return the index of the first positive element in this vector (-1 otherwise).

    e

    the ending index (exclusive) for the search

  55. def flaw(method: String, message: String): Unit

    Show the flaw by printing the error message.

    Show the flaw by printing the error message.

    method

    the method where the error occurred

    message

    the error message

    Definition Classes
    Error
  56. def foreach[U](f: (Double) ⇒ U): Unit

    Iterate over the vector element by element.

    Iterate over the vector element by element.

    f

    the function to apply

  57. final def getClass(): java.lang.Class[_]

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

    Must also override hashCode to be be compatible with equals.

    Must also override hashCode to be be compatible with equals.

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

    Definition Classes
    Any
  60. def isNonnegative: Boolean

    Check whether this vector is nonnegative (has no negative elements).

  61. def mag: Double

    Find the element with the greatest magnitude in this vector.

  62. def max(b: VectorD): VectorD

    Take the maximum of this vector with vector b (element-by element).

    Take the maximum of this vector with vector b (element-by element).

    b

    the other vector

  63. def max(e: Int = dim): Double

    Find the maximum element in this vector.

    Find the maximum element in this vector.

    e

    the ending index (exclusive) for the search

  64. def min(b: VectorD): VectorD

    Take the minimum of this vector with vector b (element-by element).

    Take the minimum of this vector with vector b (element-by element).

    b

    the other vector

  65. def min(e: Int = dim): Double

    Find the minimum element in this vector.

    Find the minimum element in this vector.

    e

    the ending index (exclusive) for the search

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

    Definition Classes
    AnyRef
  67. def norm: Double

    Compute the Euclidean norm (2-norm) of this vector.

  68. def norm1: Double

    Compute the Manhattan norm (1-norm) of this vector.

  69. def normSq: Double

    Compute the Euclidean norm (2-norm) squared of this vector.

  70. def normalize: VectorD

    Normalize this vector so that it sums to one (like a probability vector).

  71. def normalize1: VectorD

    Normalize this vector to have a maximum of one.

  72. def normalizeU: VectorD

    Normalize this vector so its length is one (unit vector).

  73. final def notify(): Unit

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

    Definition Classes
    AnyRef
  75. def oneAt(j: Int, size: Int = dim): VectorD

    Create a vector of the form (0, .

    Create a vector of the form (0, ... 1, ... 0) where the 1 is at position j.

    j

    the position to place the 1

    size

    the size of the vector (upper bound = size - 1)

  76. def ramp(size: Int = dim): VectorD

    Create a ramp-up vector of increasing values: 0, 1, 2, .

    Create a ramp-up vector of increasing values: 0, 1, 2, ..., size - 1.

    size

    the size of the vector (upper bound = size - 1)

  77. def sameDimensions(b: VectorD): Boolean

    Check whether the other vector is at least as long as this vector.

    Check whether the other vector is at least as long as this vector.

    b

    the other vector

  78. def select(basis: Array[Int]): VectorD

    Select a subset of elements of this vector corresponding to a basis.

    Select a subset of elements of this vector corresponding to a basis.

    basis

    the set of index positions (e.g., 0, 2, 5)

  79. def set(x: Double): Unit

    Set each value in this vector to x.

    Set each value in this vector to x.

    x

    the value to be assigned

  80. def setAll(u: Array[Double]): Unit

    Set the values in this vector to the values in array u.

    Set the values in this vector to the values in array u.

    u

    the array of values to be assigned

  81. def setFormat(newFormat: String): Unit

    Set the format to the newFormat.

    Set the format to the newFormat.

    newFormat

    the new format string

  82. def slice(from: Int, till: Int): VectorD

    Slice this vector from to end.

    Slice this vector from to end.

    from

    the start of the slice (included)

    till

    the end of the slice (excluded)

  83. def sort(): Unit

    Sort this vector in-place in non-decreasing order.

  84. def sq: VectorD

    Return the vector containing the square each element of this vector.

  85. def sum: Double

    Sum the elements of this vector.

  86. def sum_ne(i: Int): Double

    Sum the elements of this vector skipping the i-th element.

    Sum the elements of this vector skipping the i-th element.

    i

    the index of the element to skip

  87. def sum_pos: Double

    Sum the positive (> 0) elements of this vector.

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

    Definition Classes
    AnyRef
  89. def toString(): String

    Convert this vector to a string.

    Convert this vector to a string.

    Definition Classes
    VectorD → AnyRef → Any
  90. def tryCompareTo[B >: VectorD](b: B)(implicit arg0: (B) ⇒ PartiallyOrdered[B]): Option[Int]

    Compare this vector with vector b.

    Compare this vector with vector b.

    b

    the other vector

    Definition Classes
    VectorD → PartiallyOrdered
  91. def unary_-(): VectorD

    Return the negative of this vector (unary minus).

  92. def update(r: Range, u: VectorD): Unit

    Set this vector's elements over the given range (vector slicing).

    Set this vector's elements over the given range (vector slicing).

    r

    the given range

    u

    the vector to assign

  93. def update(r: Range, x: Double): Unit

    Set this vector's elements over the given range (vector slicing).

    Set this vector's elements over the given range (vector slicing).

    r

    the given range

    x

    the value to assign

  94. def update(i: Int, x: Double): Unit

    Set this vector's element at the i-th index position.

    Set this vector's element at the i-th index position.

    i

    the given index

    x

    the value to assign

  95. var v: Array[Double]

    the 1D array used to store vector elements

    the 1D array used to store vector elements

    Attributes
    protected
  96. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  99. def ~^(s: Double): VectorD

    Return the vector containing each element of this vector raised to the s-th power.

    Return the vector containing each element of this vector raised to the s-th power.

    s

    the scalar exponent

  100. def ~^=(s: Double): Unit

    Raise each element of this vector to the s-th power.

    Raise each element of this vector to the s-th power.

    s

    the scalar exponent

Inherited from Serializable

Inherited from Serializable

Inherited from Error

Inherited from PartiallyOrdered[VectorD]

Inherited from AnyRef

Inherited from Any