agi.foundation.numericalmethods.advanced

(agi.foundation.core-2024r3.jar)

Class DurationFunctionCollection

java.lang.Object

agi.foundation.compatibility.BaseCollection<DurationFunctionDetails>

agi.foundation.numericalmethods.advanced.DurationFunctionCollection

All Implemented Interfaces:

Iterable<DurationFunctionDetails>, Collection<DurationFunctionDetails>, List<DurationFunctionDetails>

public class DurationFunctionCollection
extends BaseCollection<DurationFunctionDetails>

A collection of functions to be explored by DurationFunctionExplorer.

Method Summary

Modifier and Type	Method and Description
DurationFunctionDetails	add(DurationSimpleFunction function) Adds a function to the collection.
DurationFunctionDetails	add(DurationSimpleFunction function, double threshold) Adds a function to the collection, and adds a threshold value that is of interest while exploring the function.
protected void	clearItems() Removes all elements from the collection.
protected void	insertItem(int index, DurationFunctionDetails item) Inserts an element into the collection at the specified index.
protected void	removeItem(int index) Removes the element at the specified index of the collection.
protected void	setItem(int index, DurationFunctionDetails item) Replaces the element at the specified index.

Methods inherited from class agi.foundation.compatibility.BaseCollection

add, add, addAll, addAll, clear, contains, containsAll, get, getItems, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

add

public final DurationFunctionDetails add(DurationSimpleFunction function,
                                         double threshold)

Adds a function to the collection, and adds a threshold value that is of interest while exploring the function.

Parameters:

function - The function to explore.

threshold - The threshold value that is of interest while exploring the function.

Returns:

An instance describing the details of this function. This instance will have already been added to this collection when this method returns.

add

public final DurationFunctionDetails add(DurationSimpleFunction function)

Adds a function to the collection. The new function will not be configured with any threshold values.

Parameters:

function - The function to explore.

Returns:

An instance describing the details of this function. This instance will have already been added to this collection when this method returns.

insertItem

protected void insertItem(int index,
                          DurationFunctionDetails item)

Inserts an element into the collection at the specified index.

Overrides:

insertItem in class BaseCollection<DurationFunctionDetails>

Parameters:

index - Index where the item is inserted.

item - The object that will be inserted.

clearItems

protected void clearItems()

Removes all elements from the collection.

Overrides:

clearItems in class BaseCollection<DurationFunctionDetails>

removeItem

protected void removeItem(int index)

Removes the element at the specified index of the collection.

Overrides:

removeItem in class BaseCollection<DurationFunctionDetails>

Parameters:

index - Index where the item is removed.

setItem

protected void setItem(int index,
                       DurationFunctionDetails item)

Replaces the element at the specified index.

Overrides:

setItem in class BaseCollection<DurationFunctionDetails>

Parameters:

index - Index where the item will be replaced.

item - The new value for the element at the specified index.