breeze.optimize

SpectralProjectedGradient

class SpectralProjectedGradient[T] extends FirstOrderMinimizer[T, DiffFunction[T]] with Projecting[T] with SerializableLogging

SPG is a Spectral Projected Gradient minimizer; it minimizes a differentiable function subject to the optimum being in some set, given by the projection operator projection

T

vector type

Linear Supertypes
Projecting[T], FirstOrderMinimizer[T, DiffFunction[T]], SerializableLogging, Serializable, Serializable, Minimizer[T, DiffFunction[T]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpectralProjectedGradient
  2. Projecting
  3. FirstOrderMinimizer
  4. SerializableLogging
  5. Serializable
  6. Serializable
  7. Minimizer
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpectralProjectedGradient(projection: (T) ⇒ T = (t: T) => t, tolerance: Double = 1e-6, suffDec: Double = 1e-4, minImprovementWindow: Int = 30, alphaMax: Double = 1e10, alphaMin: Double = 1e-10, bbMemory: Int = 10, maxIter: Int = 1, initFeas: Boolean = false, curvilinear: Boolean = false, bbType: Int = 1, maxSrcht: Int = 30)(implicit space: MutableVectorField[T, Double])

    projection

    projection operations

    tolerance

    termination criterion: tolerance for norm of projected gradient

    suffDec

    sufficient decrease parameter

    alphaMax

    longest step

    alphaMin

    shortest step

    bbMemory

    number of history entries for linesearch

    maxIter

    maximum number of iterations

    initFeas

    is the initial guess feasible, or should it be projected?

    curvilinear

    if curvilinear true, do the projection inside line search in place of doing it in chooseDescentDirection

    maxSrcht

    maximum number of iterations inside line search

Type Members

  1. case class History(alphaBB: Double, fvals: IndexedSeq[Double]) extends Product with Serializable

  2. case class State(x: T, value: Double, grad: T, adjustedValue: Double, adjustedGradient: T, iter: Int, initialAdjVal: Double, history: History, fVals: IndexedSeq[Double] = Vector(Double.PositiveInfinity), numImprovementFailures: Int = 0, searchFailed: Boolean = false) extends Product with Serializable

    Tracks the information about the optimizer, including the current point, its value, gradient, and then any history.

    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.

    fVals

    the sequence of the last minImprovementWindow values, used for checking if the "value" isn't improving

    numImprovementFailures

    the number of times in a row the objective hasn't improved, mostly for SGD

    searchFailed

    did the line search fail?

    Definition Classes
    FirstOrderMinimizer

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. def adjust(newX: T, newGrad: T, newVal: Double): (Double, T)

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  5. def adjustFunction(f: DiffFunction[T]): DiffFunction[T]

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def bbAlpha(s: T, y: T): Double

    From Mark Schmidt's Matlab code if bbType == 1 alpha = (s'*s)/(s'*y); else alpha = (s'*y)/(y'*y);

    From Mark Schmidt's Matlab code if bbType == 1 alpha = (s'*s)/(s'*y); else alpha = (s'*y)/(y'*y);

    Attributes
    protected
  8. val bbType: Int

  9. def calculateObjective(f: DiffFunction[T], x: T, history: History): (Double, T)

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  10. def chooseDescentDirection(state: State, f: DiffFunction[T]): T

    Attributes
    protected
    Definition Classes
    SpectralProjectedGradientFirstOrderMinimizer
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val curvilinear: Boolean

    if curvilinear true, do the projection inside line search in place of doing it in chooseDescentDirection

  13. def determineStepSize(state: State, f: DiffFunction[T], direction: T): Double

    Attributes
    protected
    Definition Classes
    SpectralProjectedGradientFirstOrderMinimizer
  14. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    AnyRef → Any
  19. def infiniteIterations(f: DiffFunction[T], state: State): Iterator[State]

    Definition Classes
    FirstOrderMinimizer
  20. val initFeas: Boolean

    is the initial guess feasible, or should it be projected?

  21. def initialHistory(f: DiffFunction[T], init: T): History

    Attributes
    protected
    Definition Classes
    SpectralProjectedGradientFirstOrderMinimizer
  22. def initialState(f: DiffFunction[T], init: T): State

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def iterations(f: DiffFunction[T], init: T): Iterator[State]

    Definition Classes
    FirstOrderMinimizer
  25. def logger: LazyLogger

    Attributes
    protected
    Definition Classes
    SerializableLogging
  26. val maxSrcht: Int

    maximum number of iterations inside line search

  27. val minImprovementWindow: Int

    How many iterations to improve function by at least improvementTol

    How many iterations to improve function by at least improvementTol

    Definition Classes
    FirstOrderMinimizer
  28. def minimize(f: DiffFunction[T], init: T): T

    Definition Classes
    FirstOrderMinimizerMinimizer
  29. def minimizeAndReturnState(f: DiffFunction[T], init: T): State

    Definition Classes
    FirstOrderMinimizer
  30. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  33. val numberOfImprovementFailures: Int

    Definition Classes
    FirstOrderMinimizer
  34. def projectedVector(x: T, g: T)(implicit vspace: Module[T, Double]): T

    Definition Classes
    Projecting
  35. val projection: (T) ⇒ T

    projection operations

    projection operations

    Definition Classes
    SpectralProjectedGradientProjecting
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def takeStep(state: State, dir: T, stepSize: Double): T

    Attributes
    protected
    Definition Classes
    SpectralProjectedGradientFirstOrderMinimizer
  38. def toString(): String

    Definition Classes
    AnyRef → Any
  39. def updateFValWindow(oldState: State, newAdjVal: Double): IndexedSeq[Double]

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  40. def updateHistory(newX: T, newGrad: T, newVal: Double, f: DiffFunction[T], oldState: State): History

    Attributes
    protected
    Definition Classes
    SpectralProjectedGradientFirstOrderMinimizer
  41. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Projecting[T]

Inherited from FirstOrderMinimizer[T, DiffFunction[T]]

Inherited from SerializableLogging

Inherited from Serializable

Inherited from Serializable

Inherited from Minimizer[T, DiffFunction[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped