NumPy для пользователей MATLAB

Введение

MATLAB® и NumPy имеют много общего, но NumPy создан для работы с Python, а не для того, чтобы быть клоном MATLAB. Это руководство поможет пользователям MATLAB начать работу с NumPy.

Некоторые ключевые различия

Приблизительные эквиваленты

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

В таблице ниже предполагается, что вы выполнили следующие команды в Python:

import numpy as np
from scipy import io, integrate, linalg, signal
from scipy.sparse.linalg import eigs

Также предполагается ниже, что если в Примечаниях говорится о «матрице», то аргументы являются двумерными сущностями.

Эквиваленты общего назначения

for i=1:3
    fprintf('%i\n',i)
end

for i in range(1, 4):
   print(i)

>> 4 == 4
ans = 1
>> 4 == 5
ans = 0

>>> 4 == 4
True
>>> 4 == 5
False

a=4
if a==4
    fprintf('a = 4\n')
elseif a==5
    fprintf('a = 5\n')
end

a = 4
if a == 4:
    print('a = 4')
elif a == 5:
    print('a = 5')

Эквиваленты линейной алгебры

rng(42,'twister')
rand(3,4)

from numpy.random import default_rng
rng = default_rng(42)
rng.random(3, 4)

Примечания

Подматрица: Присвоение подматрице может быть выполнено с помощью списков индексов, используя команду ix_. Например, для 2D-матрицы a, можно сделать: ind=[1, 3]; a[np.ix_(ind, ind)] += 100.

Справка: Нет прямого эквивалента команды MATLAB which, но команды help и numpy.source обычно отображают имя файла, где находится функция. Python также имеет модуль inspect (выполните import inspect), который предоставляет getfile инструмент, часто работающий.

ИНДЕКСИРОВАНИЕ: MATLAB использует индексацию, начинающуюся с 1, поэтому начальный элемент последовательности имеет индекс 1. Python использует нулевую индексацию, поэтому начальный элемент последовательности имеет индекс 0. Путаница и споры возникают, потому что у каждого есть преимущества и недостатки. Индексация, начинающаяся с 1, согласуется с обычным использованием естественного языка, где «первый» элемент последовательности имеет индекс 1. Нулевая индексация упрощает индексацию. См. также текст проф.др. Эдсгера В. Дейкстры.

ДИАПАЗОНЫ: В MATLAB 0:5 может использоваться как литерал диапазона, так и индекс «среза» (в скобках); однако в Python конструкции, подобные 0:5, только могут использоваться как индекс среза (в квадратных скобках). Таким образом, создан несколько странный r_ объект, позволяющий NumPy иметь аналогичный лаконичный механизм построения диапазонов. Обратите внимание, что r_ не вызывается как функция или конструктор, а индексируется с помощью квадратных скобок, что позволяет использовать синтаксис среза Python в аргументах.

ЛОГИЧЕСКИЕ ОПЕРАТОРЫ: & или | в NumPy — битовые AND/OR, а в MATLAB & и | — логические AND/OR. Они могут казаться одинаковыми, но есть важные различия. Если бы вы использовали операторы MATLAB & или |, вам следует использовать NumPy ufuncs logical_and/logical_or. Заметные различия между операторами MATLAB и NumPy & и |:

• Ввод нелогического типа {0,1}: на выходе NumPy — битовое AND ввода. MATLAB рассматривает любое ненулевое значение как 1 и возвращает логическое AND. Например, (3 & 4) в NumPy — 0, а в MATLAB оба 3 и 4 считаются логической истиной, и (3 & 4) возвращает 1.
• Приоритет: оператор & NumPy имеет более высокий приоритет, чем логические операторы, такие как < и >, в MATLAB — наоборот.

Если вы знаете, что у вас есть булевы аргументы, то можете обойтись операторами NumPy, но будьте осторожны с скобками, как в этом примере: z = (x > 1) & (x < 2). Отсутствие операторных форм NumPy logical_and и logical_or — нежелательный результат проектирования Python.

RESHAPE и ЛИНЕЙНАЯ ИНДЕКСАЦИЯ: MATLAB всегда позволяет обращаться к многомерным массивам с помощью скалярных или линейных индексов, NumPy — нет. Линейные индексы распространены в программах MATLAB, например, find() в матрице возвращает их, тогда как NumPy find ведёт себя по-другому. При конвертации кода MATLAB может потребоваться предварительно преобразовать матрицу в линейную последовательность, выполнить операции индексирования, а затем преобразовать обратно. Поскольку reshape (обычно) создаёт представления того же хранилища, это можно сделать достаточно эффективно. Обратите внимание, что порядок сканирования, используемый reshape в NumPy, по умолчанию — «C», а MATLAB использует порядок Fortran. Если вы просто преобразуете в линейную последовательность и обратно, это не имеет значения. Но если вы конвертируете reshape из кода MATLAB, который зависит от порядка сканирования, то этот код MATLAB: z = reshape(x,3,4); должен стать z = x.reshape(3,4,order='F').copy() в NumPy.

‘массив’ или ‘матрица’? Какой использовать?

Исторически NumPy предоставлял специальный тип матрицы, np.matrix, который является подклассом ndarray, делающим бинарные операции операциями линейной алгебры. Вы можете увидеть его в некоторых существующих кодах вместо np.array. Так какой использовать?

Кратко

Используйте массивы.

• Они поддерживают многомерную алгебру массивов, которая поддерживается в MATLAB
• Они являются стандартным типом векторов/матриц/тензоров NumPy. Многие функции NumPy возвращают массивы, а не матрицы.
• Существует чёткое различие между поэлементными операциями и операциями линейной алгебры.
• Вы можете иметь стандартные векторы или векторы строк/столбцов, если хотите.

До Python 3.5 единственным недостатком использования типа массива было то, что для умножения (сведения) двух тензоров (скалярное произведение, умножение матрицы на вектор и т. д.) нужно было использовать dot вместо *. С Python 3.5 вы можете использовать оператор матричного умножения @.

Учитывая вышесказанное, мы планируем в конечном итоге устареть matrix.

Подробно

NumPy содержит классы array и matrix. Класс array предназначен для использования в качестве многомерного массива общего назначения для многих видов числовых вычислений, а класс matrix — для облегчения вычислений линейной алгебры.

• Операторы * и @, функции dot(), и multiply():

  • Для array, ``*`` означает поэлементное умножение, а ``@`` означает матричное умножение; они имеют связанные функции multiply() и dot(). (До Python 3.5, @ не существовало, и для матричного умножения нужно было использовать dot()).
  • Для matrix, ``*`` означает матричное умножение, а для поэлементного умножения нужно использовать функцию multiply().

• Обработка векторов (одномерных массивов)

  • Для array, формы векторов 1xN, Nx1 и N — это разные вещи. Операции, такие как A[:,1] возвращают одномерный массив формы N, а не двумерный массив формы Nx1. Транспонирование одномерного array ничего не делает.
  • Для matrix, одномерные массивы всегда преобразуются в матрицы 1xN или Nx1 (строчный или столбец вектор). A[:,1] возвращает двумерную матрицу формы Nx1.

• Обработка многомерных массивов (ndim > 2)

  • array объекты могут иметь число измерений > 2;
  • matrix объекты всегда имеют ровно два измерения.

• Удобные атрибуты

  • array имеет атрибут .T, который возвращает транспонированную матрицу.
  • matrix также имеет атрибуты .H, .I и .A, которые возвращают сопряжённо-транспонированную, обратную и asarray() матрицы соответственно.

• Удобный конструктор

  • Конструктор array принимает (вложенные) Python-последовательности в качестве инициализаторов. Как в array([[1,2,3],[4,5,6]]).
  • Конструктор matrix дополнительно принимает удобную строковую инициализацию. Как в matrix("[1 2 3; 4 5 6]").

Использование обоих вариантов имеет свои плюсы и минусы:

• array

  • :) Поэлементное умножение простое: A*B.
  • :( Нужно помнить, что матричное умножение имеет свой оператор, @.
  • :) Одномерные массивы можно рассматривать как строчные или столбцовые векторы. A @ v рассматривает v как столбцовый вектор, в то время как v @ A рассматривает v как строчный вектор. Это экономит написание транспонирования.
  • :) array — это «стандартный» тип NumPy, поэтому он наиболее протестирован и чаще всего возвращается сторонним кодом, использующим NumPy.
  • :) Хорошо подходит для работы с данными любого числа измерений.
  • :) Более близкое соответствие семантике тензорной алгебры, если вы знакомы с ней.
  • :) Все операции (*, /, +, - и т. д.) выполняются поэлементно.
  • :( Разреженные матрицы из scipy.sparse не взаимодействуют так хорошо с массивами.

• matrix

  • :\\ Поведение больше похоже на поведение матриц в MATLAB.
  • <:( Максимальное число измерений — два. Для хранения трёхмерных данных необходимо использовать array или, возможно, Python-список из matrix.
  • <:( Минимальное число измерений — два. Векторы недоступны. Их нужно преобразовать в матрицы с одним столбцом или одной строкой.
  • <:( Поскольку array — это стандартный тип NumPy, некоторые функции могут возвращать array даже если вы передадите им matrix в качестве аргумента. Этого не должно происходить с функциями NumPy (если происходит — это ошибка), но сторонний код, основанный на NumPy, может не поддерживать сохранение типа, как NumPy.
  • :) A*B — это матричное умножение, поэтому запись выглядит как в линейной алгебре (для Python >= 3.5 обычные массивы имеют ту же удобную возможность с оператором @).
  • <:( Для поэлементного умножения требуется вызов функции multiply(A,B).
  • <:( Использование перегрузки операторов немного нелогично: * не работает поэлементно, но / работает.
  • Взаимодействие с scipy.sparse немного чище.

Следовательно, гораздо предпочтительнее использовать array. На самом деле, мы намерены в конечном итоге устареть matrix.

Настройка вашей среды

В MATLAB основным инструментом для настройки среды является изменение пути поиска с расположением ваших любимых функций. Вы можете поместить такие настройки в скрипт запуска, который MATLAB будет запускать при старте.

NumPy, или скорее Python, имеют аналогичные возможности.

• Для изменения пути поиска Python, чтобы включить расположение ваших собственных модулей, определите переменную среды PYTHONPATH.
• Для запуска определённого скрипта при запуске интерактивного интерпретатора Python, определите переменную среды PYTHONSTARTUP, содержащую имя вашего скрипта запуска.

В отличие от MATLAB, где любой элемент пути можно вызывать сразу, в Python вам сначала нужно выполнить инструкцию «import», чтобы сделать функции в определённом файле доступными.

Например, вы можете создать скрипт запуска, который выглядит так (Примечание: это просто пример, а не «лучшие практики»):

# Make all numpy available via shorter 'np' prefix
import numpy as np
#
# Make the SciPy linear algebra functions available as linalg.func()
# e.g. linalg.lu, linalg.eig (for general l*B@u==A@u solution)
from scipy import linalg
#
# Define a Hermitian function
def hermitian(A, **kwargs):
    return np.conj(A,**kwargs).T
# Make a shortcut for hermitian:
#    hermitian(A) --> H(A)
H = hermitian

Для использования устаревшего matrix и других matlib функций:

# Make all matlib functions accessible at the top level via M.func()
import numpy.matlib as M
# Make some matlib functions accessible directly at the top level via, e.g. rand(3,3)
from numpy.matlib import matrix,rand,zeros,ones,empty,eye

Ссылки

Ещё одна несколько устаревшая справочная таблица MATLAB/NumPy доступна по адресу http://mathesaurus.sf.net/

Подробный список инструментов для научных работ с Python можно найти на странице специализированного программного обеспечения.

Список программного обеспечения, использующего Python в качестве скриптового языка, можно найти в списке программного обеспечения Python

MATLAB® и SimuLink® — зарегистрированные товарные знаки компании The MathWorks, Inc.