Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@

/* Main Page Stylings */

.container-xl {
max-width: 1400px;
}

.intro-card {
background-color: var(--pst-color-background);
margin-bottom: 30px;
Expand Down Expand Up @@ -80,7 +76,3 @@ button span.theme-switch:hover {
.dataframe tbody th, .dataframe tbody td {
padding: 10px;
}

.bd-sidebar-primary, .bd-sidebar-secondary {
position: sticky;
}
23 changes: 23 additions & 0 deletions docs/api_reference/collections.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Collections
-----------

Matrix
~~~~~~

.. autoclass:: graphblas.Matrix
:members:
:special-members: __getitem__, __setitem__, __delitem__, __contains__, __iter__

Vector
~~~~~~

.. autoclass:: graphblas.Vector
:members:
:special-members: __getitem__, __setitem__, __delitem__, __contains__, __iter__

Scalar
~~~~~~

.. autoclass:: graphblas.Scalar
:members:
:special-members: __eq__, __bool__
7 changes: 7 additions & 0 deletions docs/api_reference/exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Exceptions
----------

.. automodule:: graphblas.exceptions
:members: InvalidObject, InvalidIndex, DomainMismatch, DimensionMismatch,
OutputNotEmpty, OutOfMemory, IndexOutOfBound, Panic, EmptyObject,
NotImplementedException, UdfParseError
133 changes: 6 additions & 127 deletions docs/api_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,131 +4,10 @@
API Reference
=============

Collections
-----------
.. toctree::
:maxdepth: 2

Matrix
~~~~~~

.. autoclass:: graphblas.Matrix
:members:
:special-members: __getitem__, __setitem__, __delitem__, __contains__, __iter__

Vector
~~~~~~

.. autoclass:: graphblas.Vector
:members:
:special-members: __getitem__, __setitem__, __delitem__, __contains__, __iter__

Scalar
~~~~~~

.. autoclass:: graphblas.Scalar
:members:
:special-members: __eq__, __bool__

Operators
---------

UnaryOp
~~~~~~~

.. autoclass:: graphblas.core.operator.UnaryOp()
:members:

BinaryOp
~~~~~~~~

.. autoclass:: graphblas.core.operator.BinaryOp()
:members:

Monoid
~~~~~~

.. autoclass:: graphblas.core.operator.Monoid()
:members:

Semiring
~~~~~~~~

.. autoclass:: graphblas.core.operator.Semiring()
:members:

IndexUnaryOp
~~~~~~~~~~~~

.. autoclass:: graphblas.core.operator.IndexUnaryOp()
:members:

SelectOp
~~~~~~~~

.. autoclass:: graphblas.core.operator.SelectOp()
:members:


Input/Output
------------

NetworkX
~~~~~~~~

These methods require `networkx <https://networkx.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_networkx

.. autofunction:: graphblas.io.to_networkx

Numpy
~~~~~

These methods require `scipy <https://scipy.org/>`_ to be installed, as some
of the scipy.sparse machinery is used during the conversion process.

.. autofunction:: graphblas.io.from_numpy

.. autofunction:: graphblas.io.to_numpy

Scipy Sparse
~~~~~~~~~~~~

These methods require `scipy <https://scipy.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_scipy_sparse

.. autofunction:: graphblas.io.to_scipy_sparse

PyData Sparse
~~~~~~~~~~~~~

These methods require `sparse <https://sparse.pydata.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_pydata_sparse

.. autofunction:: graphblas.io.to_pydata_sparse

Matrix Market
~~~~~~~~~~~~~

Matrix Market is a `plain-text format <https://math.nist.gov/MatrixMarket/formats.html>`_ for storing graphs.

These methods require `scipy <https://scipy.org/>`_ to be installed.

.. autofunction:: graphblas.io.mmread

.. autofunction:: graphblas.io.mmwrite

Visualization
~~~~~~~~~~~~~

.. autofunction:: graphblas.io.draw


Exceptions
----------

.. automodule:: graphblas.exceptions
:members: InvalidObject, InvalidIndex, DomainMismatch, DimensionMismatch,
OutputNotEmpty, OutOfMemory, IndexOutOfBound, Panic, EmptyObject,
NotImplementedException, UdfParseError
collections
operators
io
exceptions
55 changes: 55 additions & 0 deletions docs/api_reference/io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Input/Output
------------

NetworkX
~~~~~~~~

These methods require `networkx <https://networkx.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_networkx

.. autofunction:: graphblas.io.to_networkx

Numpy
~~~~~

These methods require `scipy <https://scipy.org/>`_ to be installed, as some
of the scipy.sparse machinery is used during the conversion process.

.. autofunction:: graphblas.io.from_numpy

.. autofunction:: graphblas.io.to_numpy

Scipy Sparse
~~~~~~~~~~~~

These methods require `scipy <https://scipy.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_scipy_sparse

.. autofunction:: graphblas.io.to_scipy_sparse

PyData Sparse
~~~~~~~~~~~~~

These methods require `sparse <https://sparse.pydata.org/>`_ to be installed.

.. autofunction:: graphblas.io.from_pydata_sparse

.. autofunction:: graphblas.io.to_pydata_sparse

Matrix Market
~~~~~~~~~~~~~

Matrix Market is a `plain-text format <https://math.nist.gov/MatrixMarket/formats.html>`_ for storing graphs.

These methods require `scipy <https://scipy.org/>`_ to be installed.

.. autofunction:: graphblas.io.mmread

.. autofunction:: graphblas.io.mmwrite

Visualization
~~~~~~~~~~~~~

.. autofunction:: graphblas.io.draw
38 changes: 38 additions & 0 deletions docs/api_reference/operators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Operators
---------

UnaryOp
~~~~~~~

.. autoclass:: graphblas.core.operator.UnaryOp()
:members:

BinaryOp
~~~~~~~~

.. autoclass:: graphblas.core.operator.BinaryOp()
:members:

Monoid
~~~~~~

.. autoclass:: graphblas.core.operator.Monoid()
:members:

Semiring
~~~~~~~~

.. autoclass:: graphblas.core.operator.Semiring()
:members:

IndexUnaryOp
~~~~~~~~~~~~

.. autoclass:: graphblas.core.operator.IndexUnaryOp()
:members:

SelectOp
~~~~~~~~

.. autoclass:: graphblas.core.operator.SelectOp()
:members: