Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ift
NIFTy
Commits
6fc84116
Commit
6fc84116
authored
Feb 06, 2018
by
Martin Reinecke
Browse files
remove superfluous and/or confusing documentation
parent
73b5bbab
Pipeline
#24483
passed with stage
in 6 minutes and 42 seconds
Changes
6
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
nifty4/field.py
View file @
6fc84116
...
...
@@ -46,15 +46,6 @@ class Field(object):
A numpy.type. Most common are float and complex.
copy: boolean
Attributes
----------
val : data_object
domain : DomainTuple
dtype : type
Contains the datatype stored in the Field.
"""
def
__init__
(
self
,
domain
=
None
,
val
=
None
,
dtype
=
None
,
copy
=
False
):
...
...
nifty4/minimization/line_search.py
View file @
6fc84116
...
...
@@ -29,13 +29,6 @@ class LineSearch(with_metaclass(abc.ABCMeta,
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.
Attributes
----------
line_energy : LineEnergy Object
LineEnergy object from which we can extract energy at a specific point.
preferred_initial_step_size : float
Initial guess for the step length.
"""
def
__init__
(
self
):
...
...
nifty4/minimization/line_search_strong_wolfe.py
View file @
6fc84116
...
...
@@ -48,19 +48,6 @@ class LineSearchStrongWolfe(LineSearch):
max_zoom_iterations : integer
Maximum number of iterations performed by the zoom algorithm.
(Default: 10)
Attributes
----------
c1 : float
Parameter for Armijo condition rule.
c2 : float
Parameter for curvature condition rule.
max_step_size : float
Maximum step allowed in to be made in the descent direction.
max_iterations : integer
Maximum number of iterations performed by the line search algorithm.
max_zoom_iterations : integer
Maximum number of iterations performed by the zoom algorithm.
"""
def
__init__
(
self
,
c1
=
1e-4
,
c2
=
0.9
,
...
...
nifty4/operators/diagonal_operator.py
View file @
6fc84116
...
...
@@ -44,11 +44,6 @@ class DiagonalOperator(EndomorphicOperator):
The elements of "domain" on which the operator acts.
If None, it acts on all elements.
Attributes
----------
domain : DomainTuple
The domain on which the Operator's input Field lives.
NOTE: the fields given to __init__ and returned from .diagonal() are
considered to be non-bare, i.e. during operator application, no additional
volume factors are applied!
...
...
nifty4/operators/endomorphic_operator.py
View file @
6fc84116
...
...
@@ -25,14 +25,6 @@ class EndomorphicOperator(LinearOperator):
The NIFTy EndomorphicOperator class is a class derived from the
LinearOperator. By definition, domain and target are the same in
EndomorphicOperator.
Attributes
----------
domain : DomainTuple
The domain on which the Operator's input Field lives.
target : DomainTuple
The domain in which the outcome of the operator lives. As the Operator
is endomorphic this is the same as its domain.
"""
@
property
...
...
nifty4/operators/scaling_operator.py
View file @
6fc84116
...
...
@@ -35,11 +35,6 @@ class ScalingOperator(EndomorphicOperator):
The multiplication factor
domain : tuple of DomainObjects
The domain on which the Operator's input Field lives.
Attributes
----------
domain : DomainTuple
The domain on which the Operator's input Field lives.
"""
def
__init__
(
self
,
factor
,
domain
):
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment