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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. State
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val adjustedGradient: T
  5. val adjustedValue: Double
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val convergenceInfo: ConvergenceInfo
  9. var convergenceReason: Option[ConvergenceReason]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. val grad: T
  14. val history: History
  15. val initialAdjVal: Double
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val iter: Int
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. val searchFailed: Boolean
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. val value: Double
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. val x: T

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped