You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metron.apache.org by ce...@apache.org on 2017/02/06 14:14:08 UTC
incubator-metron git commit: METRON-699: Update metron-statistics
documentation closes apache/incubator-metron#440
Repository: incubator-metron
Updated Branches:
refs/heads/master 57c38af1c -> a11e85c55
METRON-699: Update metron-statistics documentation closes apache/incubator-metron#440
Project: http://git-wip-us.apache.org/repos/asf/incubator-metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metron/commit/a11e85c5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metron/tree/a11e85c5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metron/diff/a11e85c5
Branch: refs/heads/master
Commit: a11e85c5582ebe4077ffb90378c8f81bb5fd6637
Parents: 57c38af
Author: JonZeolla <ze...@gmail.com>
Authored: Mon Feb 6 09:13:57 2017 -0500
Committer: cstella <ce...@gmail.com>
Committed: Mon Feb 6 09:13:57 2017 -0500
----------------------------------------------------------------------
metron-analytics/metron-statistics/README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/a11e85c5/metron-analytics/metron-statistics/README.md
----------------------------------------------------------------------
diff --git a/metron-analytics/metron-statistics/README.md b/metron-analytics/metron-statistics/README.md
index f6ab15f..4d78839 100644
--- a/metron-analytics/metron-statistics/README.md
+++ b/metron-analytics/metron-statistics/README.md
@@ -12,27 +12,27 @@ functions can be used from everywhere where Stellar is used.
### Approximation Statistics
-### `HLLP_ADD`
+#### `HLLP_ADD`
* Description: Add value to the HyperLogLogPlus estimator set. See [HLLP README](HLLP.md)
* Input:
* hyperLogLogPlus - the hllp estimator to add a value to
* value+ - value to add to the set. Takes a single item or a list.
* Returns: The HyperLogLogPlus set with a new value added
-### `HLLP_CARDINALITY`
+#### `HLLP_CARDINALITY`
* Description: Returns HyperLogLogPlus-estimated cardinality for this set. See [HLLP README](HLLP.md)
* Input:
* hyperLogLogPlus - the hllp set
* Returns: Long value representing the cardinality for this set
-### `HLLP_INIT`
+#### `HLLP_INIT`
* Description: Initializes the HyperLogLogPlus estimator set. p must be a value between 4 and sp and sp must be less than 32 and greater than 4. See [HLLP README](HLLP.md)
* Input:
* p - the precision value for the normal set
* sp - the precision value for the sparse set. If p is set, but sp is 0 or not specified, the sparse set will be disabled.
* Returns: A new HyperLogLogPlus set
-### `HLLP_MERGE`
+#### `HLLP_MERGE`
* Description: Merge hllp sets together. The resulting estimator is initialized with p and sp precision values from the first provided hllp estimator set. See [HLLP README](HLLP.md)
* Input:
* hllp - List of hllp estimators to merge. Takes a single hllp set or a list.