BlockMatrix
===========

(class from :py:mod:`pyomo.contrib.pynumero.sparse.block_matrix`)

.. testsetup:: *

   # import everything from the module containing this class so that
   # doctests for the class docstrings see the correct environment
   from pyomo.contrib.pynumero.sparse.block_matrix import *
   try:
       from pyomo.contrib.pynumero.sparse.block_matrix import _autosummary_doctest_setup
       _autosummary_doctest_setup()
   except ImportError:
       pass

.. currentmodule:: pyomo.contrib.pynumero.sparse.block_matrix



.. autoclass:: pyomo.contrib.pynumero.sparse.block_matrix::BlockMatrix
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~BlockMatrix.__init__
      ~BlockMatrix.block_shapes
      ~BlockMatrix.col_block_sizes
      ~BlockMatrix.coo_data
      ~BlockMatrix.copy
      ~BlockMatrix.copy_structure
      ~BlockMatrix.copyfrom
      ~BlockMatrix.copyto
      ~BlockMatrix.diagonal
      ~BlockMatrix.dot
      ~BlockMatrix.get_block
      ~BlockMatrix.get_block_column_index
      ~BlockMatrix.get_block_mask
      ~BlockMatrix.get_block_row_index
      ~BlockMatrix.get_col_size
      ~BlockMatrix.get_row_size
      ~BlockMatrix.getcol
      ~BlockMatrix.getrow
      ~BlockMatrix.has_undefined_col_sizes
      ~BlockMatrix.has_undefined_row_sizes
      ~BlockMatrix.is_col_size_defined
      ~BlockMatrix.is_empty_block
      ~BlockMatrix.is_row_size_defined
      ~BlockMatrix.mean
      ~BlockMatrix.nonzero
      ~BlockMatrix.reset_bcol
      ~BlockMatrix.reset_brow
      ~BlockMatrix.row_block_sizes
      ~BlockMatrix.set_block
      ~BlockMatrix.set_col_size
      ~BlockMatrix.set_row_size
      ~BlockMatrix.setdiag
      ~BlockMatrix.sum
      ~BlockMatrix.toarray
      ~BlockMatrix.tobsr
      ~BlockMatrix.tocoo
      ~BlockMatrix.tocsc
      ~BlockMatrix.tocsr
      ~BlockMatrix.todia
      ~BlockMatrix.tolil
      ~BlockMatrix.tostring
      ~BlockMatrix.transpose
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~BlockMatrix.T
      ~BlockMatrix.bshape
      ~BlockMatrix.dtype
      ~BlockMatrix.format
      ~BlockMatrix.nnz
      ~BlockMatrix.shape
   
   

   .. rubric:: Member Documentation