Package PyDSTool :: Module Interval' :: Class Interval

Class Interval

object --+
         |
        Interval

Numeric Interval class.

Numeric Interval implementation for integer and float types.

If the interval is not specified fully on initialisation then operations
    on the object are limited to set().

Instance Methods

[hide private]

__add__(self, val)

source code

__call__(self)

source code

__contains__(self, val)

source code

__copy__(self)

source code

__div__(self, val)

source code

__eq__(self, other)

source code

__ge__(self, other)

source code

__getitem__(self, ix)

source code

__getstate__(self)

source code

__gt__(self, other)

source code

__init__(self, name, intervaltype, intervalspec=None, abseps=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

__le__(self, other)

source code

__lt__(self, other)

source code

__mul__(self, val)

source code

__ne__(self, other)

source code

__neg__(self)

source code

__radd__(self, val)

source code

__rdiv__(self, val)

source code

__repr__(self)
str(x)

source code

__rmul__(self, val)

source code

__rsub__(self, val)

source code

__setitem__(self, ix, val)

source code

__setstate__(self, state)

source code

__str__(self)
str(x)

source code

__sub__(self, val)

source code

_infostr(self, verbose=1)
Get info on a known interval definition.

source code

atEndPoint(self, val, bdcode)
val, bdcode -> Bool

source code

contains(self, val)
Report membership of val in the interval, returning type IntervalMembership.

source code

get(self, ix=None)
Get the interval as a tuple or a number (for singletons), or an endpoint if ix is not None

source code

info(self, verboselevel=1)

source code

intersect(self, other)

source code

isfinite(self)

source code

sample(self, dt, strict=False, avoidendpoints=False)
Sample the interval, returning a list.

source code

set(self, arg)
Define interval in an Interval object

source code

uniformSample(self, dt, strict=False, avoidendpoints=False)
Sample the interval, returning a list.

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name, intervaltype, intervalspec=None, abseps=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

repr(self)
(Representation operator)

source code

str(x)

Overrides: object.__repr__: (inherited documentation)

str(self)
(Informal representation operator)

source code

str(x)

Overrides: object.__str__: (inherited documentation)

atEndPoint(self, val, bdcode)

source code

val, bdcode -> Bool

Determines whether val is at the endpoint specified by bdcode, to the precision of the interval's _abseps tolerance. bdcode can be one of 'lo', 'low', 0, 'hi', 'high', 1

sample(self, dt, strict=False, avoidendpoints=False)

source code

Sample the interval, returning a list.

Arguments:

dt : sample step

strict : (Boolean) This option forces dt to be used throughout the interval,
  with a final step of < dt if not commensurate. Default of False
  is used for auto-selection of sample rate to fit interval
  (choice based on dt argument).

avoidendpoints : (Boolean, default False). When True, ensures that the first and
  last independent variable ("t") values are not included, offset by
  an amount given by self._abseps (the endpoint tolerance).

uniformSample(self, dt, strict=False, avoidendpoints=False)

source code

Sample the interval, returning a list.

Arguments:

dt : sample step

strict : (Boolean) This option forces dt to be used throughout the interval,
  with a final step of < dt if not commensurate. Default of False
  is used for auto-selection of sample rate to fit interval
  (choice based on dt argument).

avoidendpoints : (Boolean, default False). When True, ensures that the first and
  last independent variable ("t") values are not included, offset by
  an amount given by self._abseps (the endpoint tolerance).

Class Interval

__init__(self, name, intervaltype, intervalspec=None, abseps=None) (Constructor)

__repr__(self) (Representation operator)

__str__(self) (Informal representation operator)

atEndPoint(self, val, bdcode)

sample(self, dt, strict=False, avoidendpoints=False)

uniformSample(self, dt, strict=False, avoidendpoints=False)

init(self, name, intervaltype, intervalspec=None, abseps=None)
(Constructor)

repr(self)
(Representation operator)

str(self)
(Informal representation operator)