/usr/include/openturns/swig/RegularGrid_doc.i is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | %feature("docstring") OT::RegularGrid
"Regular Grid.
Available constructors:
RegularGrid(*start, step, n*)
RegularGrid(*mesh*)
Parameters
----------
start : float
The start time stamp of the grid.
step : float, positive
The step between to consecutive time stamps.
n : int
The number of time stamps in the grid, including the start and the end time stamps.
mesh : :class:`~openturns.Mesh`
The mesh must be in :math:`\\\\Rset`, regular and sorted in the increasing order.
Notes
-----
The time stamps of the regular grid are: :math:`(t_0, \\\\dots, t_{n-1})` where :math:`t_{k} = t_0 + k \\\\Delta` for :math:`0 \\\\leq k \\\\leq n-1` and :math:`\\\\Delta >0` the step.
See also
--------
Mesh
Examples
--------
>>> import openturns as ot
>>> myRegularGrid = ot.RegularGrid(0.0, 0.1, 100)"
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getStart
"Accessor to the start time stamp.
Returns
-------
start : float
The start point :math:`t_0` of the grid."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getEnd
"Accessor to the first time stamp after the last time stamp of the grid.
Returns
-------
endPoint : float
The first point that follows the last point of the grid: :math:`t_{n-1} + \\\\Delta`. The end point is not in the grid."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getStep
"Accessor to the step.
Returns
-------
step : float
The step :math:`\\\\Delta` between two consecutive time stamps."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getN
"Accessor to the number of time stamps in the grid.
Returns
-------
n : int
The number :math:`n` of time stamps in the grid."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getValue
"Accessor to the time stamps at a gien index.
Parameters
----------
k : int, :math:`0 \\\\leq k \\\\leq n-1`.
Index of a time stamp.
Returns
-------
value : float
The time stamp :math:`t_{k}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::getValues
"Accessor to all the time stamps.
Returns
-------
values : :class:`~openturns.Point`
The collection of the time stamps."
// ---------------------------------------------------------------------
%feature("docstring") OT::RegularGrid::follows
"Check if the given grid follows the current one.
Parameters
----------
newGrid : :class:`~openturns.RegularGrid`
A new regular grid.
Returns
-------
answer : boolean
The answer is *True* if the *newGrid* directly follows the current one."
|