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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

* Added `compas.dtastructures.Network` as alias of `compas.datastructures.Graph`.

### Changed

* Merged `compas.datastructures.Network` into `compas.datastructures.Graph`.

### Removed

* Removed `compas.datastructures.Network`.

## [2.0.0-beta.2] 2024-01-12

### Added
Expand Down
3 changes: 1 addition & 2 deletions docs/api/compas.datastructures.CellNetwork.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,13 @@ Topology
~CellNetwork.halfface_opposite_cell
~CellNetwork.halfface_opposite_halfface
~CellNetwork.halfface_vertex_ancestor
~CellNetwork.halfface_vertex_descendant
~CellNetwork.halfface_vertex_descendent
~CellNetwork.halfface_vertices
~CellNetwork.has_edge
~CellNetwork.has_halfface
~CellNetwork.has_vertex
~CellNetwork.is_cell_on_boundary
~CellNetwork.is_edge_on_boundary
~CellNetwork.is_halfedge_on_boundary
~CellNetwork.is_halfface_on_boundary
~CellNetwork.is_valid
~CellNetwork.is_vertex_on_boundary
Expand Down
199 changes: 199 additions & 0 deletions docs/api/compas.datastructures.Graph.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
******************************************************************************
Graph
******************************************************************************

.. currentmodule:: compas.datastructures

.. autoclass:: Graph

Methods
=======

Constructors
------------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.from_edges
~Graph.from_json
~Graph.from_lines
~Graph.from_networkx
~Graph.from_nodes_and_edges
~Graph.from_obj
~Graph.from_pointcloud

Conversions
-----------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.to_json
~Graph.to_lines
~Graph.to_networkx
~Graph.to_obj
~Graph.to_points

Builders and Modifiers
----------------------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.add_edge
~Graph.add_node
~Graph.delete_edge
~Graph.delete_node
~Graph.join_edges
~Graph.split_edge

Accessors
---------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.edge_sample
~Graph.edges
~Graph.edges_where
~Graph.edges_where_predicate
~Graph.node_sample
~Graph.nodes
~Graph.nodes_where
~Graph.nodes_where_predicate

Attributes
----------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.edge_attribute
~Graph.edge_attributes
~Graph.edges_attribute
~Graph.edges_attributes
~Graph.node_attribute
~Graph.node_attributes
~Graph.nodes_attribute
~Graph.nodes_attributes
~Graph.update_default_edge_attributes
~Graph.update_default_node_attributes
~Graph.unset_edge_attribute
~Graph.unset_node_attribute

Topology
--------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.complement
~Graph.connected_nodes
~Graph.connected_edges
~Graph.degree
~Graph.degree_out
~Graph.degree_in
~Graph.exploded
~Graph.has_edge
~Graph.has_node
~Graph.is_leaf
~Graph.is_node_connected
~Graph.neighborhood
~Graph.neighbors
~Graph.neighbors_in
~Graph.neighbors_out
~Graph.node_edges
~Graph.number_of_edges
~Graph.number_of_nodes

Geometry
--------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.edge_coordinates
~Graph.edge_direction
~Graph.edge_end
~Graph.edge_length
~Graph.edge_line
~Graph.edge_midpoint
~Graph.edge_point
~Graph.edge_start
~Graph.edge_vector
~Graph.node_coordinates
~Graph.node_point
~Graph.node_laplacian
~Graph.node_neighborhood_centroid
~Graph.transform
~Graph.transformed

Paths
-----

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.shortest_path

Planarity
---------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.count_crossings
~Graph.embed_in_plane
~Graph.find_crossings
~Graph.find_cycles
~Graph.is_crossed
~Graph.is_planar
~Graph.is_planar_embedding
~Graph.is_xy

Matrices
--------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.adjacency_matrix
~Graph.connectivity_matrix
~Graph.degree_matrix
~Graph.laplacian_matrix

Mappings
--------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.gkey_node
~Graph.node_gkey
~Graph.node_index
~Graph.edge_index
~Graph.index_node
~Graph.index_edge

Utilities
---------

.. autosummary::
:toctree: generated/
:nosignatures:

~Graph.summary
~Graph.copy
~Graph.clear
Loading