Skip to content

Commit

Permalink
DOC: fixes to usages of element
Browse files Browse the repository at this point in the history
  • Loading branch information
kohr-h committed Aug 29, 2016
1 parent 90cebee commit fddad0a
Show file tree
Hide file tree
Showing 27 changed files with 198 additions and 193 deletions.
4 changes: 2 additions & 2 deletions odl/deform/linearized.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ def _linear_deform(template, displacement, out=None):
----------
template : `DiscreteLpVector`
Template to be deformed by a displacement field.
displacement : element of power space of `DiscreteLp`
The vector field (displacement field) used to deform the
displacement : element of power space of ``template.space``
Vector field (displacement field) used to deform the
template.
out : `numpy.ndarray`, optional
Array to which the function values of the deformed template
Expand Down
52 changes: 26 additions & 26 deletions odl/discr/diff_ops.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,15 @@ def _call(self, x, out=None):
Parameters
----------
x : ``domain`` element
Input vector to which the operator is applied to
out : ``range`` element, optional
Output vector to which the result is written
x : `domain` element
Input vector to which the operator is applied.
out : `range` element, optional
Output vector to which the result is written.
Returns
-------
out : ``range`` element
Result of the evaluation. If ``out`` is provided, the
out : `range` element
Result of the evaluation. If ``out`` was provided, the
returned object is a reference to it.
Examples
Expand Down Expand Up @@ -151,7 +151,7 @@ def derivative(self, point=None):
Parameters
----------
point : ``domain`` element, optional
point : `domain` `element-like`, optional
The point to take the derivative in. Does not change the result
since the operator is affine.
"""
Expand Down Expand Up @@ -259,15 +259,15 @@ def _call(self, x, out=None):
Parameters
----------
x : ``domain`` element
Input vector to which the `Gradient` operator is applied
out : ``range`` element, optional
Output vector to which the result is written
x : `domain` element
Input vector to which the `Gradient` operator is applied.
out : `range` element, optional
Output vector to which the result is written.
Returns
-------
out : ``range`` element
Result of the evaluation. If ``out`` is provided, the returned
out : `range` element
Result of the evaluation. If ``out`` was provided, the returned
object is a reference to it.
Examples
Expand Down Expand Up @@ -324,7 +324,7 @@ def derivative(self, point=None):
Parameters
----------
point : ``domain`` element, optional
point : `domain` element, optional
The point to take the derivative in. Does not change the result
since the operator is affine.
"""
Expand Down Expand Up @@ -440,16 +440,16 @@ def _call(self, x, out=None):
Parameters
----------
x : ``domain`` element
x : `domain` element
`ProductSpaceVector` to which the divergence operator
is applied
out : ``range`` element, optional
Output vector to which the result is written
is applied.
out : `range` element, optional
Output vector to which the result is written.
Returns
-------
out : ``range`` element
Result of the evaluation. If ``out`` is provided, the returned
out : `range` element
Result of the evaluation. If ``out`` was provided, the returned
object is a reference to it.
Examples
Expand Down Expand Up @@ -505,7 +505,7 @@ def derivative(self, point=None):
Parameters
----------
point : ``domain`` element, optional
point : `domain` element, optional
The point to take the derivative in. Does not change the result
since the operator is affine.
"""
Expand Down Expand Up @@ -576,16 +576,16 @@ def _call(self, x, out=None):
Parameters
----------
x : ``domain`` element
x : `domain` element
Input vector to which the `Laplacian` operator is
applied
out : ``range`` element, optional
out : `range` element, optional
Output vector to which the result is written
Returns
-------
out : ``range`` element
Result of the evaluation. If ``out`` is provided, the returned
out : `range` element
Result of the evaluation. If ``out`` was provided, the returned
object is a reference to it.
Examples
Expand Down Expand Up @@ -722,7 +722,7 @@ def finite_diff(f, axis=0, dx=1.0, method='forward', out=None, **kwargs):
Returns
-------
out : `numpy.ndarray`
N-dimensional array of the same shape as ``f``. If ``out`` is
N-dimensional array of the same shape as ``f``. If ``out`` was
provided, the returned object is a reference to it.
Notes
Expand Down
2 changes: 1 addition & 1 deletion odl/discr/discretization.py
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ def dspace_type(space, impl, dtype=None):
consistent with it.
impl : string
Implementation backend for the data space
dtype : type, optional
dtype : `numpy.dtype`, optional
Data type which the space is supposed to use. If ``None``, the
space type is purely determined from ``space`` and
``impl``. If given, it must be compatible with the
Expand Down
2 changes: 1 addition & 1 deletion odl/discr/lp_discr.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ def element(self, inp=None, **kwargs):
Returns
-------
element : `DiscretizedSetVector`
element : `DiscreteLpVector`
The discretized element, calculated as ``sampling(inp)`` or
``dspace.element(inp)``, tried in this order.
Expand Down
12 changes: 6 additions & 6 deletions odl/discr/tensor_ops.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,13 +333,13 @@ def derivative(self, vf):
Parameters
----------
vf : domain `element-like`
Vector field ``F`` at which to evaluate the derivative
vf : `domain` `element-like`
Vector field ``F`` at which to evaluate the derivative.
Returns
-------
deriv : `PointwiseInner`
Derivative operator at the given point ``vf``
Derivative operator at the given point ``vf``.
Raises
------
Expand Down Expand Up @@ -390,7 +390,7 @@ def __init__(self, adjoint, vfspace, vecfield, weight=None):
Space of vector fields on which the operator acts.
It has to be a product space of identical spaces, i.e. a
power space.
vecfield : domain `element-like`
vecfield : ``vfspace`` `element-like`
Vector field with which to calculate the point-wise inner
product of an input vector field
weight : `array-like` or float, optional
Expand Down Expand Up @@ -492,7 +492,7 @@ def __init__(self, vfspace, vecfield, weight=None):
Space of vector fields on which the operator acts.
It has to be a product space of identical spaces, i.e. a
power space.
vecfield : domain `element-like`
vecfield : ``vfspace`` `element-like`
Vector field with which to calculate the point-wise inner
product of an input vector field
weight : `array-like` or float, optional
Expand Down Expand Up @@ -609,7 +609,7 @@ def __init__(self, sspace, vecfield, vfspace=None, weight=None):
----------
sspace : `LinearSpace`
"Scalar" space on which the operator acts
vecfield : domain `element-like`
vecfield : `range` `element-like`
Vector field of the point-wise inner product operator
vfspace : `ProductSpace`, optional
Space of vector fields to which the operator maps. It must
Expand Down
Loading

0 comments on commit fddad0a

Please sign in to comment.