<commit_before>Storm Reference - Filter Operators and Comparators
==================================================

Todo

See the `Storm Syntax Conventions`__ for an explanation of the usage format used below.

Where specific query examples are given, they are commonly provided in pairs using operator syntax followed by the equivalent macro syntax (if available).

filter()
--------
Todo

Filter Comparison Helpers
-------------------------
Todo


.. _conventions: ../userguides/ug011_storm_basics.html#syntax-conventions
__ conventions_
<commit_msg>Update ug014_storm_ref_filter.rst<commit_after>.. highlight:: none

Storm Reference - Filter Operator, Comparators, and Helpers
===========================================================

The filter operator operates on the output of **a previous Storm query.**

The filter operator, along with various comparison operators (comparators) and helper functions can be used to filter (refine, downselect) the set of nodes returned by the Storm query, based on specified criteria.

All of these operators are defined in storm.py_.

See the `Storm Syntax Conventions`__ for an explanation of the usage format used below.

Filter operations differ in that, while there is a ``filt()`` operator within Synapse that handles filter operations, the operator syntax is not available via Storm. In other words, all filter operations within Storm are performed using **macro syntax.**

filt() ( + / - )
----------------
Filters the set of nodes output by a Storm query by either including ( + ) or excluding ( - ) a set of nodes based on specified criteria.

**Macro Syntax**




Filter Comparators
------------------


Filter Helper Funcitions
------------------------
Todo

.. _storm.py: https://github.com/vertexproject/synapse/blob/master/synapse/lib/storm.py

.. _conventions: ../userguides/ug011_storm_basics.html#syntax-conventions
__ conventions_

{'fraction_non_alphanumeric': 0.1639430680021086, 'fraction_numerical': 0.004744333157617291, 'mean_word_length': 3.8295165394402035, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2396573', 'n_tokens_mistral': 478, 'n_tokens_neox': 453, 'n_words': 205}