pynumero.sparse.block_vector.rst

BlockVector

Methods specific to :py:class:`pyomo.contrib.pynumero.sparse.block_vector.BlockVector`:

• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.set_block`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.get_block`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.block_sizes`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.get_block_size`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.is_block_defined`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copyfrom`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copyto`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copy_structure`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.set_blocks`
• :py:meth:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.pprint`

Attributes specific to :py:class:`pyomo.contrib.pynumero.sparse.block_vector.BlockVector`:

• :py:attr:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.nblocks`
• :py:attr:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.bshape`
• :py:attr:`~pyomo.contrib.pynumero.sparse.block_vector.BlockVector.has_none`

NumPy compatible methods:

• numpy.ndarray.dot()
• numpy.ndarray.sum()
• numpy.ndarray.all()
• numpy.ndarray.any()
• numpy.ndarray.max()
• numpy.ndarray.astype()
• numpy.ndarray.clip()
• numpy.ndarray.compress()
• numpy.ndarray.conj()
• numpy.ndarray.conjugate()
• numpy.ndarray.nonzero()
• numpy.ndarray.ptp()
• numpy.ndarray.round()
• numpy.ndarray.std()
• numpy.ndarray.var()
• numpy.ndarray.tofile()
• numpy.ndarray.min()
• numpy.ndarray.mean()
• numpy.ndarray.prod()
• numpy.ndarray.fill()
• numpy.ndarray.tolist()
• numpy.ndarray.flatten()
• numpy.ndarray.ravel()
• numpy.ndarray.argmax()
• numpy.ndarray.argmin()
• numpy.ndarray.cumprod()
• numpy.ndarray.cumsum()
• numpy.ndarray.copy()

For example,

>>> import numpy as np
>>> from pyomo.contrib.pynumero.sparse import BlockVector
>>> v = BlockVector(2)
>>> v.set_block(0, np.random.normal(size=100))
>>> v.set_block(1, np.random.normal(size=30))
>>> avg = v.mean()

NumPy compatible functions:

• numpy.log10()
• numpy.sin()
• numpy.cos()
• numpy.exp()
• numpy.ceil()
• numpy.floor()
• numpy.tan()
• numpy.arctan()
• numpy.arcsin()
• numpy.arccos()
• numpy.sinh()
• numpy.cosh()
• numpy.abs()
• numpy.tanh()
• numpy.arccosh()
• numpy.arcsinh()
• numpy.arctanh()
• numpy.fabs()
• numpy.sqrt()
• numpy.log()
• numpy.log2()
• numpy.absolute()
• numpy.isfinite()
• numpy.isinf()
• numpy.isnan()
• numpy.log1p()
• numpy.logical_not()
• numpy.expm1()
• numpy.exp2()
• numpy.sign()
• numpy.rint()
• numpy.square()
• numpy.positive()
• numpy.negative()
• numpy.rad2deg()
• numpy.deg2rad()
• numpy.conjugate()
• numpy.reciprocal()
• numpy.signbit()
• numpy.add()
• numpy.multiply()
• numpy.divide()
• numpy.subtract()
• numpy.greater()
• numpy.greater_equal()
• numpy.less()
• numpy.less_equal()
• numpy.not_equal()
• numpy.maximum()
• numpy.minimum()
• numpy.fmax()
• numpy.fmin()
• numpy.equal()
• numpy.logical_and()
• numpy.logical_or()
• numpy.logical_xor()
• numpy.logaddexp()
• numpy.logaddexp2()
• numpy.remainder()
• numpy.heaviside()
• numpy.hypot()

For example,

>>> import numpy as np
>>> from pyomo.contrib.pynumero.sparse import BlockVector
>>> v = BlockVector(2)
>>> v.set_block(0, np.random.normal(size=100))
>>> v.set_block(1, np.random.normal(size=30))
>>> inf_norm = np.max(np.abs(v))

.. autoclass:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.set_block

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.get_block

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.block_sizes

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.get_block_size

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.is_block_defined

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copyfrom

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copyto

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.copy_structure

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.set_blocks

.. automethod:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.pprint

.. autoproperty:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.nblocks

.. autoproperty:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.bshape

.. autoproperty:: pyomo.contrib.pynumero.sparse.block_vector.BlockVector.has_none