statget

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

Синтаксис

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

Описание

val = statget(options,param) возвращает значение параметра, заданного param в структуре опций статистики options. Вход param является вектором символов или скаляром строки названия параметра. Если параметр не определен в options, statget возвращает []. Необходимо ввести только достаточно начальных символов, чтобы задать название параметра исключительно. statget игнорирует регистр для названий параметра. Для доступного 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. Потоковая опция, как принимают некоторые функции, управляет что поток (потоки) использовать в генерации случайных чисел в функции. Если 'UseSubstreams' является true, Потоковое значение должно быть скаляром или должно быть пустым. Если 'UseParallel' является true, и 'UseSubstreams' является false, то аргумент Streams должен или быть пустым, или его длина должен совпадать с количеством процессоров, используемых в вычислении: равняйтесь размеру parpool, если parpool открыт, скаляр в противном случае.

TolBnd

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

TolFun

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

TolTypeFun

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

  • 'abs'

  • 'rel'

TolTypeX

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

  • 'abs'

  • 'rel'

TolX

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

Tune

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

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