Skip to content

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
geronimo-iia committed May 4, 2020
1 parent 51b896a commit 7c554b4
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 17 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,17 @@ search_direct_relationships(

## API

[search_edges](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_edges)
[search_nodes](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_nodes)
[search_direct_relationships](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_direct_relationships)
Actually, we have:

- [search_edges](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_edges)
- [search_nodes](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_nodes)
- [search_direct_relationships](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_direct_relationships)


All this function are based on [prepare_query](https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.prepare_query) which return an Evaluator.

Quickly, ```Evaluator``` are function with this signature: (context) -> bool
And ```Context``` is a dictionary like structure (with in and [] methods, and support __contains__ or (__iter__ and __getitem__))
With networkX, node and edge attributes are dictionary like.
Quickly, ```Evaluator``` are function with this signature: (context) -> bool, and ```Context``` is a dictionary like structure (with in and [] methods, and support __contains__ or (__iter__ and __getitem__))
With networkX, node and edge attributes are dictionary like, so implementation of this three methods are very simple.



Expand Down Expand Up @@ -230,7 +231,8 @@ is equivalent to:

## Wished Features

- add match node, edges, path specification
- add set expression on node/edges with constraints
- add projection expression (a return like statement)
- add join relation ship
- add path condition between node


18 changes: 10 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,13 +259,15 @@ <h3>Searching relation ship<a class="headerlink" href="#searching-relation-ship"
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_edges">search_edges</a>
<a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_nodes">search_nodes</a>
<a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_direct_relationships">search_direct_relationships</a></p>
<p>Actually, we have:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_edges">search_edges</a></p></li>
<li><p><a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_nodes">search_nodes</a></p></li>
<li><p><a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.search_direct_relationships">search_direct_relationships</a></p></li>
</ul>
<p>All this function are based on <a class="reference external" href="https://geronimo-iia.github.io/networkx-query/api.html#networkx_query.prepare_query">prepare_query</a> which return an Evaluator.</p>
<p>Quickly, <code class="docutils literal notranslate"><span class="pre">Evaluator</span></code> are function with this signature: (context) -&gt; bool
And <code class="docutils literal notranslate"><span class="pre">Context</span></code> is a dictionary like structure (with in and [] methods, and support <strong>contains</strong> or (<strong>iter</strong> and <strong>getitem</strong>))
With networkX, node and edge attributes are dictionary like.</p>
<p>Quickly, <code class="docutils literal notranslate"><span class="pre">Evaluator</span></code> are function with this signature: (context) -&gt; bool, and <code class="docutils literal notranslate"><span class="pre">Context</span></code> is a dictionary like structure (with in and [] methods, and support <strong>contains</strong> or (<strong>iter</strong> and <strong>getitem</strong>))
With networkX, node and edge attributes are dictionary like, so implementation of this three methods are very simple.</p>
</div>
<div class="section" id="query-language">
<h2>Query language<a class="headerlink" href="#query-language" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -441,8 +443,8 @@ <h3>Boolean composition of matching expression<a class="headerlink" href="#boole
<div class="section" id="wished-features">
<h2>Wished Features<a class="headerlink" href="#wished-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>add match node, edges, path specification</p></li>
<li><p>add set expression on node/edges with constraints</p></li>
<li><p>add projection expression (a return like statement)</p></li>
<li><p>add join relation ship</p></li>
<li><p>add path condition between node</p></li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7c554b4

Please sign in to comment.