@@ -11,31 +11,36 @@ Note that you want SciPy >= 0.7.2
...
@@ -11,31 +11,36 @@ Note that you want SciPy >= 0.7.2
.. warning::
.. warning::
In SciPy 0.6, ``scipy.csc_matrix.dot`` has a bug with singleton
In SciPy 0.6, `scipy.csc_matrix.dot` has a bug with singleton
dimensions. There may be more bugs. It also has inconsistent
dimensions. There may be more bugs. It also has inconsistent
implementation of sparse matrices.
implementation of sparse matrices.
We do not test against SciPy versions below 0.7.2.
We do not test against SciPy versions below 0.7.2.
We describe the details of the compressed sparse matrix types.
We describe the details of the compressed sparse matrix types.
``scipy.sparse.csc_matrix``
`scipy.sparse.csc_matrix`
should be used if there are more rows than column (shape[0] > shape[1]).
should be used if there are more rows than column (``shape[0] > shape[1]``).
``scipy.sparse.csr_matrix``
`scipy.sparse.csr_matrix`
should be used if there are more columns than rows (shape[0] < shape[1]).
should be used if there are more columns than rows (``shape[0] < shape[1]``).
``scipy.sparse.lil_matrix``
`scipy.sparse.lil_matrix`
is faster if we are modifying the array. After initial inserts,
is faster if we are modifying the array. After initial inserts,
we can then convert to the appropriate sparse matrix format.
we can then convert to the appropriate sparse matrix format.
The following types also exist:
The following types also exist:
``dok_matrix``
`dok_matrix`
Dictionary of Keys format. From their doc: This is an efficient structure for constructing sparse matrices incrementally.
Dictionary of Keys format. From their doc: This is an efficient structure for constructing sparse matrices incrementally.
``coo_matrix``
`coo_matrix`
Coordinate format. From their lil doc: consider using the COO format when constructing large matrices.
Coordinate format. From their lil doc: consider using the COO format when constructing large matrices.
There seems to be a new format planned for scipy 0.7.x:
There seems to be a new format planned for SciPy 0.7.x:
``bsr_matrix``
`bsr_matrix`
Block Compressed Row (BSR). From their doc: The Block Compressed Row (BSR) format is very similar to the Compressed Sparse Row (CSR) format. BSR is appropriate for sparse matrices with dense sub matrices like the last example below. Block matrices often arise in vector-valued finite element discretizations. In such cases, BSR is considerably more efficient than CSR and CSC for many sparse arithmetic operations.
Block Compressed Row (BSR). From their doc: The Block Compressed Row
``dia_matrix``
(BSR) format is very similar to the Compressed Sparse Row (CSR)
format. BSR is appropriate for sparse matrices with dense sub matrices
like the last example below. Block matrices often arise in vector-valued
finite element discretizations. In such cases, BSR is considerably more
efficient than CSR and CSC for many sparse arithmetic operations.
`dia_matrix`
Sparse matrix with DIAgonal storage
Sparse matrix with DIAgonal storage
There are four member variables that comprise a compressed matrix ``sp`` (for at least csc, csr and bsr):
There are four member variables that comprise a compressed matrix ``sp`` (for at least csc, csr and bsr):
...
@@ -52,9 +57,9 @@ There are four member variables that comprise a compressed matrix ``sp`` (for at
...
@@ -52,9 +57,9 @@ There are four member variables that comprise a compressed matrix ``sp`` (for at
row location.
row location.
``sp.indptr``
``sp.indptr``
gives the other location of the non-zero entry. For CSC, there are
gives the other location of the non-zero entry. For CSC, there are
as many values of indptr as there are columns + 1 in the matrix.
as many values of indptr as there are ``columns + 1`` in the matrix.
``sp.indptr[k] = x`` and ``indptr[k+1] = y`` means that column
``sp.indptr[k] = x`` and ``indptr[k+1] = y`` means that column
k contains sp.data[x:y], i.e. the xth through the y-1th non-zero values.
``k`` contains ``sp.data[x:y]``, i.e. the ``x``-th through the y-1th non-zero values.
See the example below for details.
See the example below for details.
...
@@ -63,7 +68,7 @@ See the example below for details.
...
@@ -63,7 +68,7 @@ See the example below for details.
>>> import scipy.sparse
>>> import scipy.sparse
>>> sp = scipy.sparse.csc_matrix((5, 10))
>>> sp = scipy.sparse.csc_matrix((5, 10))
>>> sp[4, 0] = 20
>>> sp[4, 0] = 20
/u/lisa/local/byhost/test_maggie46.iro.umontreal.ca/lib64/python2.5/site-packages/scipy/sparse/compressed.py:494: SparseEfficiencyWarning: changing the sparsity structure of a csc_matrix is expensive. lil_matrix is more efficient.
SparseEfficiencyWarning: changing the sparsity structure of a csc_matrix is expensive. lil_matrix is more efficient.
SparseEfficiencyWarning)
SparseEfficiencyWarning)
>>> sp[0, 0] = 10
>>> sp[0, 0] = 10
>>> sp[2, 3] = 30
>>> sp[2, 3] = 30
...
@@ -91,13 +96,13 @@ Several things should be learned from the above example:
...
@@ -91,13 +96,13 @@ Several things should be learned from the above example:
* We actually use the wrong sparse matrix type. In fact, it is the
* We actually use the wrong sparse matrix type. In fact, it is the
*rows* that are sparse, not the columns. So, it would have been
*rows* that are sparse, not the columns. So, it would have been
better to use ``sp = scipy.sparse.csr_matrix((5, 10))``.
better to use ``sp = scipy.sparse.csr_matrix((5, 10))``.
* We should have actually created the matrix as a ``lil_matrix``,
* We should have actually created the matrix as a `lil_matrix`,
which is more efficient for inserts. Afterwards, we should convert
which is more efficient for inserts. Afterwards, we should convert
to the appropriate compressed format.
to the appropriate compressed format.
* `sp.indptr[0] = 0` and `sp.indptr[1] = 2`, which means that
* ``sp.indptr[0] = 0`` and ``sp.indptr[1] = 2``, which means that
column 0 contains sp.data[0:2], i.e. the first two non-zero values.
column 0 contains ``sp.data[0:2]``, i.e. the first two non-zero values.
* `sp.indptr[3] = 2` and `sp.indptr[4] = 3`, which means that column
* ``sp.indptr[3] = 2`` and ``sp.indptr[4] = 3``, which means that column
3 contains sp.data[2:3], i.e. the third non-zero value.
three contains ``sp.data[2:3]``, i.e. the third non-zero value.
TODO: Rewrite this documentation to do things in a smarter way.
TODO: Rewrite this documentation to do things in a smarter way.
...
@@ -112,7 +117,7 @@ For faster sparse code:
...
@@ -112,7 +117,7 @@ For faster sparse code:
Misc
Misc
----
----
The sparse equivalent of dmatrix is csc_matrix and csr_matrix.
The sparse equivalent of `dmatrix` is `csc_matrix` and `csr_matrix`.
:class:`~aesara.sparse.basic.Dot` vs. :class:`~aesara.sparse.basic.StructuredDot`
:class:`~aesara.sparse.basic.Dot` vs. :class:`~aesara.sparse.basic.StructuredDot`
