case class State[+T, +ConvergenceInfo, +History](x: T, value: Double, grad: T, adjustedValue: Double, adjustedGradient: T, iter: Int, initialAdjVal: Double, history: History, convergenceInfo: ConvergenceInfo, searchFailed: Boolean = false, convergenceReason: Option[ConvergenceReason] = None) extends Product with Serializable
Tracks the information about the optimizer, including the current point, its value, gradient, and then any history. Also includes information for checking convergence.
- x
the current point being considered
- value
f(x)
- grad
f.gradientAt(x)
- adjustedValue
f(x) + r(x), where r is any regularization added to the objective. For LBFGS, this is f(x).
- adjustedGradient
f'(x) + r'(x), where r is any regularization added to the objective. For LBFGS, this is f'(x).
- iter
what iteration number we are on.
- initialAdjVal
f(x_0) + r(x_0), used for checking convergence
- history
any information needed by the optimizer to do updates.
- searchFailed
did the line search fail?
- convergenceReason
the convergence reason
- Alphabetic
- By Inheritance
- State
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
State(x: T, value: Double, grad: T, adjustedValue: Double, adjustedGradient: T, iter: Int, initialAdjVal: Double, history: History, convergenceInfo: ConvergenceInfo, searchFailed: Boolean = false, convergenceReason: Option[ConvergenceReason] = None)
- x
the current point being considered
- value
f(x)
- grad
f.gradientAt(x)
- adjustedValue
f(x) + r(x), where r is any regularization added to the objective. For LBFGS, this is f(x).
- adjustedGradient
f'(x) + r'(x), where r is any regularization added to the objective. For LBFGS, this is f'(x).
- iter
what iteration number we are on.
- initialAdjVal
f(x_0) + r(x_0), used for checking convergence
- history
any information needed by the optimizer to do updates.
- searchFailed
did the line search fail?
- convergenceReason
the convergence reason
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val adjustedGradient: T
- val adjustedValue: Double
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- val convergenceInfo: ConvergenceInfo
- var convergenceReason: Option[ConvergenceReason]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val grad: T
- val history: History
- val initialAdjVal: Double
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val iter: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val searchFailed: Boolean
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val value: Double
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val x: T