mlreportgen.finder.Finder class

Пакет: mlreportgen.finder
Суперклассы:

Описание

mlreportgen.finder.Finder является абстрактным классом объектов поиска для поиска объектов результатов, которые могут быть добавлены в mlreportgen.report.Report объект. Используйте этот класс как базис для создания собственного класса finder.

Свойства

расширить все

Контейнер, который должен быть найден поисковиком. Тип данных зависит от типа контейнера, который нужно искать. Для примера, для имени переменной, тип данных является вектором символов или строкой.

Свойства объектов для поиска, заданные как массив ячеек из пар "имя-значение". Поисковик возвращает только объекты с заданными свойствами с заданными значениями.

Пример: finder.Properties = {'Gain','5'}

Методы

results = find(finder) находит элементы в контейнере, заданном поиском. Этот метод возвращает элементы, которые он находит упакованными в объекты результата. Эти объекты результатов могут быть добавлены непосредственно в отчеты типа mlreportgen.report.Report или slreportgen.report.Report. Можно также добавить результаты в отчет, который затем добавляется в отчет.

tf = hasNext(finder) определяет, содержит ли контейнер, который ищет поисковик, по крайней мере, один из заданных элементов для поиска. Если контейнер имеет хотя бы один элемент, hasNext метод помещает этот элемент в очередь как следующий элемент, который next метод вернется. The hasNext затем метод возвращает true. Используйте next способ получения этого элемента. При последующих вызовах hasNext метод определяет, имеет ли контейнер элемент, который next метод еще не получен. Он ставит элемент в очередь для next метод для извлечения и возвратов true. Если больше нет элементов, которые нужно извлечь, этот метод возвращается false. Для постепенного поиска элементов в контейнере используйте hasNext метод с next метод в a while цикл.

result = next(finder) возвращает следующую result поиска в очереди результатов, которую hasNext создан метод. Этот метод возвращает элемент, который он находит, завернутый в mlreportgen.finder.Result объект. Чтобы добавить таблицы свойств элемента, добавьте объект результата к отчету непосредственно или добавьте его к репортеру, который вы затем добавили к отчету. Отчеты, в которые можно добавить results этого метода должен быть типа mlreportgen.report.Report.

tf = isIterating(finder) проверяет, выполняется ли итерация искателя для поиска результатов. Если trueВы не можете изменить какие-либо свойства поиска.

tf = mustNotBeIterating(finder) или tf = mustNotBeIterating(finder,propertyName) проверяет, что поисковик не выполняет итерацию для поиска результатов. Если true, искатель не должен быть итерацией, и вы можете изменить значения свойств и т.д. Если false, искатель итератируется, и вы не можете изменить его свойства и т.д. Необязательный propertyName вход - свойство, которое изменяется и вызывает ошибку.

tf = satisfyObjectPropertiesConstraint(finder,obj) определяет, является ли obj имеет свойство, которое удовлетворяет Properties ограничение, заданное поиском.

reset(finder) устанавливает искатель в его начальное состояние, так что вызывая next(finder) возвращает первый результат и сбрасывает состояния объекта.

Копировать семантику

Указатель. Чтобы узнать, как классы handle влияют на операции копирования, см. раздел «Копирование объектов».

Введенный в R2018a