Package paramz :: Package core :: Module observable_array :: Class ObsAr

Class ObsAr

An ndarray which reports changes to its observers.

.. warning:

  ObsAr tries to not ever give back an observable array itself. Thus,
  if you want to preserve an ObsAr you need to work in memory. Let
  `a` be an ObsAr and you want to add a random number `r` to it. You need to
  make sure it stays an ObsAr by working in memory (see numpy for details):

  .. code-block:: python

      a[:] += r

The observers can add themselves with a callable, which will be called every time this array changes. The callable takes exactly one argument, which is this array itself.

Instance Methods

[hide private]

__array_finalize__(self, obj)
None.

source code

Object of same type as ndarray object a.

__array_wrap__(self, out_arr, context=None)

source code

_setup_observers(self)

source code

copy(self)
Make a copy.

source code

Deep copy of array

__deepcopy__(self, memo)
Used if copy.deepcopy is called on an array.

source code

__reduce__(self)
For pickling.

source code

__setstate__(self, state)
For unpickling.

source code

__setitem__(self, s, val)
x[i]=y

source code

__getslice__(self, start, stop)
x[i:j]

source code

__setslice__(self, start, stop, val)
x[i:j]=y

source code

__ilshift__(self, *args, **kwargs)
x<<=y

source code

__irshift__(self, *args, **kwargs)
x>>=y

source code

__ixor__(self, *args, **kwargs)
x^=y

source code

__ipow__(self, *args, **kwargs)
x**=y

source code

__ifloordiv__(self, *args, **kwargs)
x//=y

source code

__isub__(self, *args, **kwargs)
x-=y

source code

__ior__(self, *args, **kwargs)
x|=y

source code

__itruediv__(self, *args, **kwargs)
x/=y

source code

__idiv__(self, *args, **kwargs)
x/=y

source code

__iand__(self, *args, **kwargs)
x&=y

source code

__imod__(self, *args, **kwargs)
x%=y

source code

__iadd__(self, *args, **kwargs)
x+=y

source code

__imul__(self, *args, **kwargs)
x*=y

source code

Inherited from numpy.ndarray: __abs__, __add__, __and__, __array__, __array_prepare__, __complex__, __contains__, __copy__, __delitem__, __delslice__, __div__, __divmod__, __eq__, __float__, __floordiv__, __ge__, __getitem__, __gt__, __hex__, __index__, __int__, __invert__, __iter__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __oct__, __or__, __pos__, __pow__, __radd__, __rand__, __rdiv__, __rdivmod__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __sizeof__, __str__, __sub__, __truediv__, __xor__, all, any, argmax, argmin, argpartition, argsort, astype, byteswap, choose, clip, compress, conj, conjugate, cumprod, cumsum, diagonal, dot, dump, dumps, fill, flatten, getfield, item, itemset, max, mean, min, newbyteorder, nonzero, partition, prod, ptp, put, ravel, repeat, reshape, resize, round, searchsorted, setfield, setflags, sort, squeeze, std, sum, swapaxes, take, tobytes, tofile, tolist, tostring, trace, transpose, var, view

Inherited from pickleable.Pickleable: __getstate__, __init__, pickle

Inherited from observable.Observable: add_observer, change_priority, notify_observers, remove_observer, set_updates

Inherited from object: __delattr__, __format__, __getattribute__, __reduce_ex__, __setattr__, __subclasshook__

Static Methods

[hide private]

a new object with type S, a subtype of T

__new__(cls, input_array, *a, **kw)

source code

Class Variables

[hide private]

__array_priority__ = -1
Array priority.

Inherited from numpy.ndarray: __hash__

Properties

[hide private]

values
Return the ObsAr underlying array as a standard ndarray.

Inherited from numpy.ndarray: T, __array_interface__, __array_struct__, base, ctypes, data, dtype, flags, flat, imag, itemsize, nbytes, ndim, real, shape, size, strides

Inherited from object: __class__

Method Details

Class ObsAr

__new__(cls, input_array, *a, **kw) Static Method

__array_finalize__(self, obj)

__array_wrap__(self, out_arr, context=None)

copy(self)

__deepcopy__(self, memo)

__reduce__(self)

__setstate__(self, state)

__setitem__(self, s, val) (Index assignment operator)

__getslice__(self, start, stop) (Slicling operator)

__setslice__(self, start, stop, val) (Slice assignment operator)

__ilshift__(self, *args, **kwargs)

__irshift__(self, *args, **kwargs)

__ixor__(self, *args, **kwargs)

__ipow__(self, *args, **kwargs)

__ifloordiv__(self, *args, **kwargs)

__isub__(self, *args, **kwargs)

__ior__(self, *args, **kwargs)

__itruediv__(self, *args, **kwargs)

__idiv__(self, *args, **kwargs)

__iand__(self, *args, **kwargs)

__imod__(self, *args, **kwargs)

__iadd__(self, *args, **kwargs)

__imul__(self, *args, **kwargs)

values

new(cls, input_array, *a, **kw)
Static Method

deepcopy(self, memo)

reduce(self)

setstate(self, state)

setitem(self, s, val)
(Index assignment operator)

getslice(self, start, stop)
(Slicling operator)

setslice(self, start, stop, val)
(Slice assignment operator)

ilshift(self, *args, **kwargs)

irshift(self, *args, **kwargs)

ixor(self, *args, **kwargs)

ipow(self, *args, **kwargs)

ifloordiv(self, *args, **kwargs)

isub(self, *args, **kwargs)

ior(self, *args, **kwargs)

itruediv(self, *args, **kwargs)

idiv(self, *args, **kwargs)

iand(self, *args, **kwargs)

imod(self, *args, **kwargs)

iadd(self, *args, **kwargs)

imul(self, *args, **kwargs)