statget

Доступ к значениям в структуре опций статистики

Синтаксис

val = statget(options,param)
val = statget(options,param,default)

Описание

val = statget(options,param) возвращает значение параметра, заданное как param в структуре опций статистики options. Область входа param является вектором символов или строковым скаляром имени параметра. Если параметр не определен в options, statget возвращает []. Вам нужно ввести только достаточно начальных символов, чтобы задать имя параметра однозначно. statget игнорирует case для имен параметров. Для доступных options, см. «Входы».

val = statget(options,param,default) возвращает default если заданный параметр не определен в структуре опций оптимизации options.

Входные параметры

DerivStep

Относительное различие, используемая в вычислениях производного различия. Положительная скалярная величина или вектор положительных скалярных величин того же размера, что и вектор параметров, оцененных Statistics and Machine Learning Toolbox™, функционируют с использованием структуры опций.

Display

Количество информации, отображаемой алгоритмом.

  • 'off' - Информация не отображается.

  • 'final' - Отображает окончательный выход.

  • 'iter' - Отображает итерационный выход в командное окно для некоторых функций; в противном случае отображается окончательный выход.

FunValCheck

Проверьте недопустимые значения, такие как NaN или Inf, от целевой функции.

  • 'off'

  • 'on'

GradObj

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

  • 'off'

  • 'on'

Jacobian

Помечает, возвращает ли целевая функция якобиан в качестве второго выхода.

  • 'off'

  • 'on'

MaxFunEvals

Максимально допустимое количество вычислений целевой функции. Положительное целое число.

MaxIter

Максимально допустимое количество итераций. Положительное целое число.

OutputFcn

Решатель вызывает все выходные функции после каждой итерации.

  • Указатель на функцию задается как @

  • массив ячеек с указателями на функцию

  • пустой массив (по умолчанию)

Robust

Активируйте опцию устойчивой модели.

  • 'off'

  • 'on'

RobustWgtFun

Весовая функция для робастного подбора кривой. Действителен только при Robust является 'on'. Может также быть указателем на функцию, который принимает нормированную невязку как вход и возвращает устойчивые веса как выход.

  • 'bisquare'

  • 'andrews'

  • 'cauchy'

  • 'fair'

  • 'huber'

  • 'logistic'

  • 'talwar'

  • 'welsch'

Streams

Один образец файла RandStream класс или массив ячеек RandStream образцы. Опция Streams принимается некоторыми функциями, чтобы управлять тем, какие потоки использовать при генерации случайных чисел в функции. Если 'UseSubstreams' является true, значение Streams должно быть скаляром или должно быть пустым. Если 'UseParallel' является true и 'UseSubstreams' является false, тогда аргумент Streams должен быть либо пустым, либо его длина должна совпадать с количеством процессоров, используемых в расчете: равным parpool размеру, если parpool открыто, скаляром в противном случае.

TolBnd

Допуск, связанный с параметром. Положительная скалярная величина.

TolFun

Допуск завершения для значения целевой функции. Положительная скалярная величина.

TolTypeFun

Использование TolFun для абсолютных или относительных допусков целевой функции.

  • 'abs'

  • 'rel'

TolTypeX

Использование TolX для абсолютных или относительных допусков параметра.

  • 'abs'

  • 'rel'

TolX

Допуск завершения для параметров. Положительная скалярная величина.

Tune

Константа настройки, используемая в устойчивом подборе кривой, чтобы нормализовать невязки перед применением функции веса. Значение по умолчанию зависит от функции weight. Этот параметр необходим, если вы задаете функцию веса как указатель на функцию. Положительная скалярная величина.

UseParallel

Флаг, указывающий, должны ли подходящие функции использовать возможности Parallel Computing Toolbox™ (PCT), если эти возможности доступны. То есть, если PCT установлен, и PCT parpool находится в эффекте. Допустимые значения false (по умолчанию), для последовательных расчетов и true, для параллельных расчетов.

UseSubstreams

Флаг, указывающий, должен ли генератор случайных чисел в подходящих функциях использовать Substream свойство RandStream класс. false (по умолчанию) или true. Когда true, итерации высокого уровня внутри функции установят Substream свойство значению итерации. Это поведение помогает генерировать воспроизводимые потоки случайных чисел в параллельных и/или последовательных режимах расчета.

WgtFun

Весовая функция для робастного подбора кривой. Действителен только при Robust является 'on'. Может также быть указателем на функцию, который принимает нормированную невязку как вход и возвращает устойчивые веса как выход.

  • 'bisquare'

  • 'andrews'

  • 'cauchy'

  • 'fair'

  • 'huber'

  • 'logistic'

  • 'talwar'

  • 'welsch'

Примеры

Этот оператор возвращает значение Display параметр опции из структуры называется my_options.

val = statget(my_options,'Display')

Верните значение Display параметр опции из структуры называется my_options (как в предыдущем примере). Если на Display параметр не определен, statget возвращает значение 'final'.

optnew = statget(my_options,'Display','final');

См. также

Представлено до R2006a

Statistics and Machine Learning Toolbox документация

Поддержка

Для просмотра документации необходимо авторизоваться на сайте