Документация Engee

mean

Среднее значение элементов массива.

Библиотека

EngeeDSP

Синтаксис

Вызов функции

  • M = mean(A) — возвращает среднее значение элементов массива A по первому измерению, размер которого не равен 1.

    • Если A — вектор, то mean(A) возвращает среднее значение элементов A.

    • Если A — матрица, то mean(A) — вектор-строка, содержащая среднее значение каждого столбца A.

    • Если A — многомерный массив, то mean(A) действует по первому измерению A, размер которого не равен 1, рассматривая элементы как векторы. Размер M в этом измерении становится равным 1, в то время как размеры всех остальных измерений остаются такими же, как в A.

  • M = mean(A, "all") — возвращает среднее значение по всем элементам A.

  • M = mean(A, dim) — возвращает среднее значение по размерности dim. Например, если A — матрица, то mean(A,2) возвращает вектор-столбец, содержащий среднее значение каждой строки.

  • M = mean(A, vecdim) — возвращает среднее значение по размерности, указанной в векторе vecdim. Например, если A — матрица, то mean(A,[],[1 2]) возвращает среднее значение по всем элементам матрицы A, поскольку каждый элемент матрицы содержится в слое массива, определяемом размерностями 1 и 2.

  • M = mean(___, missingflag) — также задает способ обработки пропущенных значений для любого из предыдущих вариантов синтаксиса. Например, mean(A,"omitnan") игнорирует все пропущенные значения при вычислении среднего. По умолчанию mean включает пропущенные значения.

  • M = mean(___, Weight=W) — определяет схему взвешивания W и возвращает среднее взвешенное. Подробнее см. в разделе Среднее взвешенное.

Аргументы

Входные аргументы

# A — входные данные
скаляр | вектор | матрица | многомерный массив

Details

Входные данные, заданные как скаляр, вектор, матрица или многомерный массив.

  • Если A — скаляр, то mean(A) возвращает A.

  • Если A — пустая матрица размером 0 на 0, то mean(A) возвращает NaN.

Типы данных

Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool

# dim — измерение, по которому выполняется операция
скаляр

Details

Измерение, по которому выполняется операция, задается как положительный целочисленный скаляр. Если измерение не указано, то по умолчанию используется первое измерение массива, размер которого не равен 1.

Размерность dim указывает измерение, длина которого уменьшается до 1. Размер size(M, dim) равен 1, в то время как размеры всех остальных измерений остаются прежними.

Рассмотрим входную матрицу A размером на :

  • mean(A,1) вычисляет среднее значение элементов в каждом столбце матрицы A и возвращает вектор-строку размером 1 на .

mean 1

  • mean(A,2) вычисляет среднее значение элементов в каждой строке матрицы A и возвращает вектор-столбец размером 1 на .

mean 2

# vecdim — вектор измерений
вектор

Details

Вектор измерений, заданный как вектор положительных целых чисел. Каждый элемент представляет измерение входного массива. Длина выходных данных в указанных рабочих измерениях равна 1, в то время как остальные измерения остаются неизменными.

Рассмотрим входной массив A размером 2×3×3. Тогда std(A,0,[1 2]) возвращает массив размером 1×1×3, элементы которого являются средними значениями, вычисленными для каждого слоя A.

std 3 ru

# missingflag — условие отсутствия значения
"includemissing" (по умолчанию) | "includenan" | "omitmissing" | "omitnan"

Details

Условие отсутствия значения, заданное как:

  • "includemissing" или "includenan" при вычислении среднего значения учитывает пропущенные значения во входных данных A. Если какой-либо элемент в рабочем измерении отсутствует, то соответствующий элемент в M также отсутствует.

  • "omitmissing" или "omitnan" при вычислении среднего значения игнорирует пропущенные значения во входных данных A. Если все элементы в рабочем измерении отсутствуют, то соответствующий элемент в M тоже отсутствует.

# W — схема взвешивания
вектор | матрица | многомерный массив

Details

Схема взвешивания, заданная как вектор, матрица или многомерный массив. Элементы W должны быть неотрицательными.

Если указана схема взвешивания, то функция mean возвращает средневзвешенное значение, что полезно, когда значения во входных данных имеют разную степень важности или входные данные асимметричны.

Если W — вектор, он должен иметь ту же длину, что и рабочее измерение. В противном случае W должен иметь тот же размер, что и входные данные.

Вы не можете указать этот аргумент, если используется аргумент vecdim или метод M = mean(A, "all").

Типы данных

Float32, Float64

Выходные аргументы

# M — среднее значение
скаляр | вектор | матрица | многомерный массив

Details

Средние значения, возвращаемые в виде скаляра, вектора, матрицы или многомерного массива.

Примеры

Среднее значение элементов матрицы

Details

Создадим матрицу.

import EngeeDSP.Functions: mean

A = [0 1 1; 2 3 2; 1 3 2; 4 2 2]
4×3 Matrix{Int64}:
 0  1  1
 2  3  2
 1  3  2
 4  2  2

Вычислим среднее значение каждого столбца.

M = mean(A)
1×3 Matrix{Float64}:
 1.75  2.25  1.75

Вычислим среднее значение каждой строки.

M = mean(A,2)
4×1 Matrix{Float64}:
 0.6666666666666666
 2.3333333333333335
 2.0
 2.6666666666666665

Вычислим среднее значение всех элементов матрицы.

M = mean(A,"all")
1.9166666666666667

Дополнительно

Среднее значение

Details

Для вектора конечной длины, состоящего из скалярных величин, среднее значение определяется как

Среднее взвешенное

Details

Для вектора конечной длины, состоящего из скалярных величин, и схемы взвешивания среднее взвешенное определяется как