summaryrefslogtreecommitdiff
path: root/doc/reference/classes
Commit message (Collapse)AuthorAgeFilesLines
* DOC: list pred method for MultiDiGraphs (#6409)Mridul Seth2023-02-031-1/+1
|
* plugin based backend infrastructure to use multiple computation backends (#6000)Mridul Seth2022-11-081-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Wrappers classes to dispatch to a backend * Rework the backend dispatching - Use __networkx_plugin__=name to find graph-like objects instead of subclassing - Add PluginInfo to smooth over differences in importlib.metadata across python versions - Add dispatch behavior override via environment variable to aid in testing plugins * Dispatch more algorithms and improve auto-test capabilities * Allow dispatcher decorator without a name - Name is taken from the decorated function - Raise error if backend doesn't implement a decorated function which is called - Check for duplicate names for dispatching algorithms * Make sphinx pick up backend docs * make black happy * Rename decorator to _dispatch as it's experimental * A few more dispatched functions * Make convert to and from methods for auto-testing - Rename `convert` to `convert_from_nx` - Add `convert_to_nx` function These will allow backends to return native objects when dispatching, but provide a mechanism to convert the result to the type expected by NetworkX tests for the auto-test plugin mechanism. * More dispatching * Include name with `convert_**_nx` methods * Remove known plugin names This check is not needed, as any plugin can register itself in the entry points section. The dispatching and auto-testing explicitly specify the plugin to use, so there is no need to hardcode the options. These were originally included for security, but any malicious actor would simply use one of the valid names, so having a hardcoded list does not actually provide any meaningful security. * Add `dispatchname` to dispatchable functions Co-authored-by: Jim Kitchen <jim22k@gmail.com> Co-authored-by: Erik Welch <erik.n.welch@gmail.com>
* Minor doc fixups (#5868)Ross Barnowski2022-07-151-1/+0
| | | | | | | | | * Fix examples section formatting in condensed docstr. * Rm stray reference to ordered grpahs. * Add naive LCA algs to reference guide. * Fix heading names in LCA docstrings.
* Remove OrderedGraphs (#5813)Jarrod Millman2022-07-122-20/+3
| | | | | | Removes the deprecated OrderedGraph classes. Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Dan Schult <dschult@colgate.edu>
* Add coreview objects to documentation (#4431)Ross Barnowski2020-12-071-0/+19
| | | | | * DOC: Add coreviews to reference guide. * DOC: Add brief module docstring to coreviews.
* Docs update (#4161)Dan Schult2020-08-161-0/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fixes #3955 (boundary_expansion docs) * add to docs for steiner_tree * Add missing functions to docs. Thanks to #4111 * Doc fixups * Put filters onto the doc pages. * Add @jamestrimble doc compare script to repo and expand * Fix latex syntax in docs for trophic * more latex corrections * deprecate edge_betweeness and betweeness_centrality_source. warnings and add to list of deprecations * Use docs to identify hopcrfot_karo_matching and maximum_matching * remove underscore from _naive_greedy_modularity_communities * cite James Trimble for code that finds missing functions * Update parallel_betweenness example to avoid deprecated function betweenness_centrality_source should be replaced by betweenness_centrality_subset in plot_parallel_betweenness. find _naive_greedy and change name * tweak
* Add method to clear edges only (#3477)Paolo Lammens2020-07-054-0/+4
| | | | | | | | | | | | | | | | | | | | | | | * feat: `clear_edges` in `networkx.Graph` Method to clear all edges in a graph without altering nodes or graph attributes. Added corresponding test too. * tests: improve `test_clear` in `TestGraph` Added a graph attribute before clearing to test its proper deletion. too. * tests: add tests for `clear` and `clear_edges` specific to DiGraph To test that DiGraph-specific edge records are cleared as well. * fix: specific `clear_edges` for `DiGraph` So that DiGraph's pred/succ also get cleared. * Convert docstrings tests and docs reference links to add clear_edges Co-authored-by: Dan Schult <dschult@colgate.edu>
* Improved graph class selection table (#3570)Salim BELHADDAD2019-09-041-8/+11
| | | | - Suggestion for beginners to make clear that multi(di-)graphs can also have loops. - Used the word 'allowed' to suggest that the feature is optional.
* Update docs with all functions left out of rst files (#3091)Dan Schult2018-07-271-0/+11
| | | | | | | | * Update docs with all functions not added to rst files Also add script to find these functions * put back removed periods after references
* Simplify the Graphview and SubGraphView system (#3073)Dan Schult2018-07-204-4/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Simplify the Graphview and SubGraphView system - add tests to show that extensions of base graph classes (only add new functions) should be able to use the Graph.subgraph and Graph.copy methods easily - Remove ReadOnlyGraph class in favor of existing freeze() function - Switch all GraphView classes to generic_graph_view function - Switch all SubGraph classes to subgraph_view function - Introduce deprecated functions that act like the deprecated classes. Still need to: - add docs - add tests - make sure backward compatible and marked as deprecated - remove GraphView and SubGraph construct from rest of codebase - update release docs Fixes #2889 Fixes #2793 Fixes #2796 Fixes #2741 * Ease subclassing for to_(un)directed - add to_directed_class indicator functions to base classes - start deprecating G.fresh_copy - update function.to(un)directed * Remove G.fresh_copy from code replace with __class__ Add deprecation warnings for GraphView classes, ReverseView and SubGraph. Also for fresh_copy function.
* Add base class method `update` (#3028)Dan Schult2018-06-284-0/+4
| | | Part of #1393
* Review and update tutorial/docs due to 2.0 changes (#2650)Dan Schult2017-09-075-35/+46
| | | | | | | | | | * Revamp tutorial.rst * update docs and simpliy nbunch usage * Revise base class docs * Read-through and tweak rst files
* Fix docs (#2607)Jarrod Millman2017-08-124-16/+0
| | | Changes mostly due to PR #2604.
* Revise docs (#2524)Jarrod Millman2017-07-196-0/+394
* Finish directory reorg and make minor text edits * Remove cruft from conf.py * Fix broken links and comply with pep8