Commit 82eaf21f authored by Martin Reinecke's avatar Martin Reinecke

doc tweaks

parent 03cb016f
Pipeline #25151 passed with stages
in 5 minutes and 41 seconds
......@@ -115,7 +115,7 @@ class DomainTuple(object):
@property
def axes(self):
"""tuple of tuple of int : shapes of the underlying domains"""
"""tuple of tuple of int : axis indices of the underlying domains"""
return self._axtuple
def __len__(self):
......
......@@ -43,7 +43,8 @@ class IterationController(NiftyMetaBase()):
@abc.abstractmethod
def start(self, energy):
"""
"""Starts the iteration.
Parameters
----------
energy : Energy object
......@@ -57,7 +58,8 @@ class IterationController(NiftyMetaBase()):
@abc.abstractmethod
def check(self, energy):
"""
"""Checks the state of the iteration. Called after every step.
Parameters
----------
energy : Energy object
......
......@@ -23,9 +23,10 @@ from ..utilities import NiftyMetaBase
class LineSearch(NiftyMetaBase()):
"""Class for determining the optimal step size along some descent direction.
Initialize the line search procedure which can be used by a specific line
search method. It finds the step size in a specific direction in the
minimization process.
Parameters
----------
preferred_initial_step_size : float, optional
Newton-based methods should intialize this to 1.
"""
def __init__(self, preferred_initial_step_size=None):
......@@ -33,4 +34,25 @@ class LineSearch(NiftyMetaBase()):
@abc.abstractmethod
def perform_line_search(self, energy, pk, f_k_minus_1=None):
"""Find step size and advance.
Determines a good step size and advances the current estimate
by this step size in the search direction.
Parameters
----------
energy : Energy
Energy object from which we will calculate the energy and the
gradient at a specific point.
pk : Field
Vector pointing into the search direction.
f_k_minus_1 : float, optional
Value of the fuction (which is being minimized) at the k-1
iteration of the line search procedure. (Default: None)
Returns
-------
Energy
The new Energy object on the new position.
"""
raise NotImplementedError
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