mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-18 04:12:19 +00:00
DOCSUP-10111: Documented the entropy aggregate function (#30237)
* initial commit * Update draft * small fix
This commit is contained in:
parent
68e75c2727
commit
af86aea90d
@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
toc_priority: 302
|
||||||
|
---
|
||||||
|
|
||||||
|
# entropy {#entropy}
|
||||||
|
|
||||||
|
Calculates [Shannon entropy](https://en.wikipedia.org/wiki/Entropy_(information_theory)) of a column of values.
|
||||||
|
|
||||||
|
**Syntax**
|
||||||
|
|
||||||
|
``` sql
|
||||||
|
entropy(val)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
|
||||||
|
- `val` — Column of values of any type.
|
||||||
|
|
||||||
|
**Returned value**
|
||||||
|
|
||||||
|
- Shannon entropy.
|
||||||
|
|
||||||
|
Type: [Float64](../../../sql-reference/data-types/float.md).
|
||||||
|
|
||||||
|
**Example**
|
||||||
|
|
||||||
|
Query:
|
||||||
|
|
||||||
|
``` sql
|
||||||
|
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:
|
||||||
|
|
||||||
|
``` text
|
||||||
|
┌─entropy(vals)─┬─entropy(strings)─┐
|
||||||
|
│ 1 │ 1.75 │
|
||||||
|
└───────────────┴──────────────────┘
|
||||||
|
```
|
@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
toc_priority: 302
|
||||||
|
---
|
||||||
|
|
||||||
|
# entropy {#entropy}
|
||||||
|
|
||||||
|
Вычисляет [информационную энтропию](https://ru.wikipedia.org/wiki/%D0%98%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D0%B0%D1%8F_%D1%8D%D0%BD%D1%82%D1%80%D0%BE%D0%BF%D0%B8%D1%8F) столбца данных.
|
||||||
|
|
||||||
|
**Синтаксис**
|
||||||
|
|
||||||
|
``` sql
|
||||||
|
entropy(val)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Аргументы**
|
||||||
|
|
||||||
|
- `val` — столбец значений любого типа
|
||||||
|
|
||||||
|
**Возвращаемое значение**
|
||||||
|
|
||||||
|
- Информационная энтропия.
|
||||||
|
|
||||||
|
Тип: [Float64](../../../sql-reference/data-types/float.md).
|
||||||
|
|
||||||
|
**Пример**
|
||||||
|
|
||||||
|
Запрос:
|
||||||
|
|
||||||
|
``` sql
|
||||||
|
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;
|
||||||
|
```
|
||||||
|
|
||||||
|
Результат:
|
||||||
|
|
||||||
|
``` text
|
||||||
|
┌─entropy(vals)─┬─entropy(strings)─┐
|
||||||
|
│ 1 │ 1.75 │
|
||||||
|
└───────────────┴──────────────────┘
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user