ClickHouse/docs/en/sql-reference/aggregate-functions/reference/entropy.md
gyuton af86aea90d
DOCSUP-10111: Documented the entropy aggregate function (#30237)
* initial commit

* Update draft

* small fix
2021-10-25 14:47:18 +03:00

850 B

toc_priority
302

entropy

Calculates Shannon entropy of a column of values.

Syntax

entropy(val)

Arguments

  • val — Column of values of any type.

Returned value

  • Shannon entropy.

Type: Float64.

Example

Query:

CREATE TABLE entropy (`vals` UInt32,`strings` String) ENGINE = Memory;

INSERT INTO entropy VALUES (1, 'A'), (1, 'A'), (1,'A'), (1,'A'), (2,'B'), (2,'B'), (2,'C'), (2,'D');

SELECT entropy(vals), entropy(strings) FROM entropy;

Result:

┌─entropy(vals)─┬─entropy(strings)─┐
│             1 │             1.75 │
└───────────────┴──────────────────┘