Commit 16e2992b authored by Jakob Knollmueller's avatar Jakob Knollmueller

few changes

parent ad3a7d38
......@@ -26,18 +26,18 @@ class Energy(Loggable, object):
Parameters
----------
position : Field
position : Field, float
The parameter of the scalar function and its first and second derivative.
Attributes
----------
position : Field
position : Field, float
The Field location in parameter space where value, gradient and curvature is evaluated.
value : float
The evaluation of the energy functional at given position.
gradient : Field
The gradient at given position in parameter direction.
curvature : InvertibleOperator
curvature : callable
An implicit operator encoding the curvature at given position.
Raises
......@@ -88,10 +88,6 @@ class Energy(Loggable, object):
def position(self):
return self._position
@position.setter
def position(self, position):
self._position = position
@property
def value(self):
raise NotImplementedError
......
......@@ -21,6 +21,21 @@ from .line_searching import LineSearchStrongWolfe
class RelaxedNewton(QuasiNewtonMinimizer):
""" A implementation of the relaxed Newton minimization scheme.
The relaxed Newton minimization exploits gradient and curvature information to
propose a step. A linesearch optimizes along this direction.
Parameter
---------
line_searcher : LineSearch,
An implementation of a line-search algorithm.
callback :
convergence_tolerance : float,
Specifies the
convergence_level :
iteration_limit :
"""
def __init__(self, line_searcher=LineSearchStrongWolfe(), callback=None,
convergence_tolerance=1E-4, convergence_level=3,
iteration_limit=None):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment