breeze.optimize

BatchDiffFunction

trait BatchDiffFunction[T] extends DiffFunction[T] with (T, IndexedSeq[Int]) ⇒ Double

A diff function that supports subsets of the data. By default it evaluates on all the data

Self Type
BatchDiffFunction[T]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BatchDiffFunction
  2. Function2
  3. DiffFunction
  4. StochasticDiffFunction
  5. NumericOps
  6. ImmutableNumericOps
  7. Function1
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def calculate(x: T, batch: IndexedSeq[Int]): (Double, T)

    Calculates the value and gradient of the function on a subset of the data

  2. abstract def fullRange: IndexedSeq[Int]

    The full size of the data

Concrete 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. final def %[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMod.Impl2[TT, B, That]): That

    Alias for :%(b) when b is a scalar.

    Alias for :%(b) when b is a scalar.

    Definition Classes
    ImmutableNumericOps
  5. final def %:%[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMod.Impl2[TT, B, That]): That

    Element-wise modulo of this and b.

    Element-wise modulo of this and b.

    Definition Classes
    ImmutableNumericOps
  6. final def %=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpMod.InPlaceImpl2[TT, B]): DiffFunction[T]

    Alias for :%=(b) when b is a scalar.

    Alias for :%=(b) when b is a scalar.

    Definition Classes
    NumericOps
  7. final def &[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpAnd.Impl2[TT, B, That]): That

    Alias for :&&(b) for all b.

    Alias for :&&(b) for all b.

    Definition Classes
    ImmutableNumericOps
  8. final def &:&[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpAnd.Impl2[TT, B, That]): That

    Element-wise logical "and" operator -- returns true if corresponding elements are non-zero.

    Element-wise logical "and" operator -- returns true if corresponding elements are non-zero.

    Definition Classes
    ImmutableNumericOps
  9. final def &=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpAnd.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise and of this and b.

    Mutates this by element-wise and of this and b.

    Definition Classes
    NumericOps
  10. final def *[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMulMatrix.Impl2[TT, B, That]): That

    Matrix multiplication (and scalar multiplication that follows standard order of operations)

    Matrix multiplication (and scalar multiplication that follows standard order of operations)

    Definition Classes
    ImmutableNumericOps
  11. final def *:*[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMulScalar.Impl2[TT, B, That]): That

    Element-wise product of this and b.

    Element-wise product of this and b.

    Definition Classes
    ImmutableNumericOps
  12. final def *=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpMulScalar.InPlaceImpl2[TT, B]): DiffFunction[T]

    Alias for :*=(b) when b is a scalar.

    Alias for :*=(b) when b is a scalar.

    Definition Classes
    NumericOps
  13. final def +[TT >: DiffFunction[T], B, C, That](b: B)(implicit op: linalg.operators.OpAdd.Impl2[TT, B, That]): That

    Alias for :+(b) for all b.

    Alias for :+(b) for all b.

    Definition Classes
    NumericOps
  14. final def +:+[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpAdd.Impl2[TT, B, That]): That

    Element-wise sum of this and b.

    Element-wise sum of this and b.

    Definition Classes
    ImmutableNumericOps
  15. final def +=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpAdd.InPlaceImpl2[TT, B]): DiffFunction[T]

    Alias for :+=(b) for all b.

    Alias for :+=(b) for all b.

    Definition Classes
    NumericOps
  16. final def -[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpSub.Impl2[TT, B, That]): That

    Alias for :-(b) for all b.

    Alias for :-(b) for all b.

    Definition Classes
    ImmutableNumericOps
  17. final def -:-[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpSub.Impl2[TT, B, That]): That

    Element-wise difference of this and b.

    Element-wise difference of this and b.

    Definition Classes
    ImmutableNumericOps
  18. final def -=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpSub.InPlaceImpl2[TT, B]): DiffFunction[T]

    Alias for :-=(b) for all b.

    Alias for :-=(b) for all b.

    Definition Classes
    NumericOps
  19. final def /[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpDiv.Impl2[TT, B, That]): That

    Alias for :/(b) when b is a scalar.

    Alias for :/(b) when b is a scalar.

    Definition Classes
    ImmutableNumericOps
  20. final def /:/[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpDiv.Impl2[TT, B, That]): That

    Element-wise quotient of this and b.

    Element-wise quotient of this and b.

    Definition Classes
    ImmutableNumericOps
  21. final def /=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpDiv.InPlaceImpl2[TT, B]): DiffFunction[T]

    Alias for :/=(b) when b is a scalar.

    Alias for :/=(b) when b is a scalar.

    Definition Classes
    NumericOps
  22. final def :!=[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpNe.Impl2[TT, B, That]): That

    Element-wise inequality comparator of this and b.

    Element-wise inequality comparator of this and b.

    Definition Classes
    ImmutableNumericOps
  23. final def :%=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpMod.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise modulo of b into this.

    Mutates this by element-wise modulo of b into this.

    Definition Classes
    NumericOps
  24. final def :&=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpAnd.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise and of this and b.

    Mutates this by element-wise and of this and b.

    Definition Classes
    NumericOps
  25. final def :*=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpMulScalar.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise multiplication of b into this.

    Mutates this by element-wise multiplication of b into this.

    Definition Classes
    NumericOps
  26. final def :+=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpAdd.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise addition of b into this.

    Mutates this by element-wise addition of b into this.

    Definition Classes
    NumericOps
  27. final def :-=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpSub.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise subtraction of b from this

    Mutates this by element-wise subtraction of b from this

    Definition Classes
    NumericOps
  28. final def :/=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpDiv.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise division of b into this

    Mutates this by element-wise division of b into this

    Definition Classes
    NumericOps
  29. final def :=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpSet.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise assignment of b into this.

    Mutates this by element-wise assignment of b into this.

    Definition Classes
    NumericOps
  30. final def :==[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpEq.Impl2[TT, B, That]): That

    Element-wise equality comparator of this and b.

    Element-wise equality comparator of this and b.

    Definition Classes
    ImmutableNumericOps
  31. final def :^=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpPow.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise exponentiation of this by b.

    Mutates this by element-wise exponentiation of this by b.

    Definition Classes
    NumericOps
  32. final def :^^=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpXor.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise xor of this and b.

    Mutates this by element-wise xor of this and b.

    Definition Classes
    NumericOps
  33. final def :|=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpOr.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise or of this and b.

    Mutates this by element-wise or of this and b.

    Definition Classes
    NumericOps
  34. final def <:<[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpLT.Impl2[TT, B, That]): That

    Element-wise less=than comparator of this and b.

    Element-wise less=than comparator of this and b.

    Definition Classes
    NumericOps
  35. final def <:=[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpLTE.Impl2[TT, B, That]): That

    Element-wise less-than-or-equal-to comparator of this and b.

    Element-wise less-than-or-equal-to comparator of this and b.

    Definition Classes
    NumericOps
  36. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  38. final def >:=[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpGTE.Impl2[TT, B, That]): That

    Element-wise greater-than-or-equal-to comparator of this and b.

    Element-wise greater-than-or-equal-to comparator of this and b.

    Definition Classes
    NumericOps
  39. final def >:>[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpGT.Impl2[TT, B, That]): That

    Element-wise greater-than comparator of this and b.

    Element-wise greater-than comparator of this and b.

    Definition Classes
    NumericOps
  40. def \[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpSolveMatrixBy.Impl2[TT, B, That]): That

    Shaped solve of this by b.

    Shaped solve of this by b.

    Definition Classes
    ImmutableNumericOps
  41. final def ^:^[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpPow.Impl2[TT, B, That]): That

    Element-wise exponentiation of this and b.

    Element-wise exponentiation of this and b.

    Definition Classes
    ImmutableNumericOps
  42. final def ^^[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpXor.Impl2[TT, B, That]): That

    Alias for :^^(b) for all b.

    Alias for :^^(b) for all b.

    Definition Classes
    ImmutableNumericOps
  43. final def ^^:^^[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpXor.Impl2[TT, B, That]): That

    Element-wise logical "xor" operator -- returns true if only one of the corresponding elements is non-zero.

    Element-wise logical "xor" operator -- returns true if only one of the corresponding elements is non-zero.

    Definition Classes
    ImmutableNumericOps
  44. final def ^^=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpXor.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise xor of this and b.

    Mutates this by element-wise xor of this and b.

    Definition Classes
    NumericOps
  45. def andThen[A](g: (Double) ⇒ A): (T) ⇒ A

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  46. def apply(x: T, batch: IndexedSeq[Int]): Double

    Definition Classes
    BatchDiffFunction → Function2
  47. final def apply(x: T): Double

    Definition Classes
    StochasticDiffFunction → Function1
  48. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  49. def cached(implicit copy: CanCopy[T]): DiffFunction[T]

    Definition Classes
    BatchDiffFunctionDiffFunction
  50. def calculate(x: T): (Double, T)

    Calculates both the value and the gradient at a point

    Calculates both the value and the gradient at a point

    Definition Classes
    BatchDiffFunctionStochasticDiffFunction
  51. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. def compose[A](g: (A) ⇒ T): (A) ⇒ Double

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  53. def curried: (T) ⇒ (IndexedSeq[Int]) ⇒ Double

    Definition Classes
    Function2
    Annotations
    @unspecialized()
  54. final def dot[TT >: DiffFunction[T], B, BB >: B, That](b: B)(implicit op: linalg.operators.OpMulInner.Impl2[TT, BB, That]): That

    Inner product of this and b.

    Inner product of this and b.

    Definition Classes
    ImmutableNumericOps
  55. final def eq(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef → Any
  59. def gradientAt(x: T): T

    calculates the gradient at a point

    calculates the gradient at a point

    Definition Classes
    BatchDiffFunctionStochasticDiffFunction
  60. def gradientAt(x: T, batch: IndexedSeq[Int]): T

    Calculates the gradient of the function on a subset of the data

  61. def groupItems(groupSize: Int): BatchDiffFunction[T]

  62. def hashCode(): Int

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

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

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

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

    Definition Classes
    AnyRef
  67. def repr: DiffFunction[T]

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

    Definition Classes
    AnyRef
  69. final def t[TT >: DiffFunction[T], That, Slice1, Result](a: Slice1)(implicit op: CanTranspose[TT, That], canSlice: CanSlice[That, Slice1, Result]): Result

    A transposed view of this object, followed by a slice.

    A transposed view of this object, followed by a slice. Sadly frequently necessary.

    Definition Classes
    ImmutableNumericOps
  70. final def t[TT >: DiffFunction[T], That, Slice1, Slice2, Result](a: Slice1, b: Slice2)(implicit op: CanTranspose[TT, That], canSlice: CanSlice2[That, Slice1, Slice2, Result]): Result

    A transposed view of this object, followed by a slice.

    A transposed view of this object, followed by a slice. Sadly frequently necessary.

    Definition Classes
    ImmutableNumericOps
  71. final def t[TT >: DiffFunction[T], That](implicit op: CanTranspose[TT, That]): That

    A transposed view of this object.

    A transposed view of this object.

    Definition Classes
    ImmutableNumericOps
  72. def throughLens[U](implicit l: Isomorphism[T, U]): BatchDiffFunction[U]

    Lenses provide a way of mapping between two types, which we typically use to convert something to a DenseVector or other Tensor for optimization purposes.

    Lenses provide a way of mapping between two types, which we typically use to convert something to a DenseVector or other Tensor for optimization purposes.

    Definition Classes
    BatchDiffFunctionDiffFunctionStochasticDiffFunction
  73. def toString(): String

    Definition Classes
    Function2 → AnyRef → Any
  74. def tupled: ((T, IndexedSeq[Int])) ⇒ Double

    Definition Classes
    Function2
    Annotations
    @unspecialized()
  75. final def unary_![TT >: DiffFunction[T], That](implicit op: linalg.operators.OpNot.Impl[TT, That]): That

    Definition Classes
    ImmutableNumericOps
  76. final def unary_-[TT >: DiffFunction[T], That](implicit op: linalg.operators.OpNeg.Impl[TT, That]): That

    Definition Classes
    ImmutableNumericOps
  77. def valueAt(x: T): Double

    calculates the value at a point

    calculates the value at a point

    Definition Classes
    BatchDiffFunctionStochasticDiffFunction
  78. def valueAt(x: T, batch: IndexedSeq[Int]): Double

    Calculates the value of the function on a subset of the data

  79. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. def withRandomBatches(size: Int): StochasticDiffFunction[T]

  83. def withScanningBatches(size: Int): StochasticDiffFunction[T]

  84. final def |[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpOr.Impl2[TT, B, That]): That

    Alias for :||(b) for all b.

    Alias for :||(b) for all b.

    Definition Classes
    ImmutableNumericOps
  85. final def |:|[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpOr.Impl2[TT, B, That]): That

    Element-wise logical "or" operator -- returns true if either element is non-zero.

    Element-wise logical "or" operator -- returns true if either element is non-zero.

    Definition Classes
    ImmutableNumericOps
  86. final def |=[TT >: DiffFunction[T], B](b: B)(implicit op: linalg.operators.OpOr.InPlaceImpl2[TT, B]): DiffFunction[T]

    Mutates this by element-wise or of this and b.

    Mutates this by element-wise or of this and b.

    Definition Classes
    NumericOps

Deprecated Value Members

  1. final def :%[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMod.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use %:% instead.

  2. final def :&[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpAnd.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use &:& instead.

  3. final def :*[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpMulScalar.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use *:* instead.

  4. final def :+[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpAdd.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use +:+ instead.

  5. final def :-[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpSub.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use -:- instead.

  6. final def :/[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpDiv.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use /:/ instead.

  7. final def :<[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpLT.Impl2[TT, B, That]): That

    Definition Classes
    NumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use <:< instead.

  8. final def :<=[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpLTE.Impl2[TT, B, That]): That

    Definition Classes
    NumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use <:= instead.

  9. final def :>[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpGT.Impl2[TT, B, That]): That

    Definition Classes
    NumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use >:> instead.

  10. final def :>=[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpGTE.Impl2[TT, B, That]): That

    Definition Classes
    NumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use >:= instead.

  11. final def :^[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpPow.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use : instead.

  12. final def :^^[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpXor.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use : instead.

  13. final def :|[TT >: DiffFunction[T], B, That](b: B)(implicit op: linalg.operators.OpOr.Impl2[TT, B, That]): That

    Definition Classes
    ImmutableNumericOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.13) This operator has confusing and often surprising precedence that leads to bugs. Use |:| instead.

Inherited from (T, IndexedSeq[Int]) ⇒ Double

Inherited from DiffFunction[T]

Inherited from StochasticDiffFunction[T]

Inherited from NumericOps[DiffFunction[T]]

Inherited from ImmutableNumericOps[DiffFunction[T]]

Inherited from (T) ⇒ Double

Inherited from AnyRef

Inherited from Any

Ungrouped