agi.foundation

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

Interface IEvaluatorOverIntervals<TResult,TResultOverIntervals>

Type Parameters:

TResult - The type returned by the evaluator when evaluated at a specific JulianDate.

TResultOverIntervals - The type returned by the evaluator when evaluated over a time interval or set of time intervals.

All Superinterfaces:

AutoCloseable, IAvailability, ICloneWithContext, IDisposable, IEvaluator, IEvaluator1<TResult>, IThreadAware

All Known Implementing Classes:

AccessEvaluator

public interface IEvaluatorOverIntervals<TResult,TResultOverIntervals>
extends IEvaluator1<TResult>

An interface for an evaluator that supports evaluation over an interval (or intervals) of time, in addition to evaluation at a specific JulianDate. The type of return value may be different for an evaluation over a single date compared to evaluation over an interval or a set of intervals. An evaluator implementing this interface may also optionally report progress via ITrackCalculationProgress.

Method Summary

Modifier and Type	Method and Description
TResultOverIntervals	evaluate(JulianDate start, JulianDate end) Evaluates from the start date until the end date.
TResultOverIntervals	evaluate(JulianDate start, JulianDate end, ITrackCalculationProgress tracker) Evaluates from the start date until the end date.
TResultOverIntervals	evaluate(TimeInterval consideredInterval) Evaluates over a single considered time interval.
TResultOverIntervals	evaluate(TimeIntervalCollection consideredIntervals) Evaluates over the supplied time intervals.
TResultOverIntervals	evaluate(TimeIntervalCollection consideredIntervals, ITrackCalculationProgress tracker) Evaluates over the supplied time intervals.
TResultOverIntervals	evaluate(TimeInterval consideredInterval, ITrackCalculationProgress tracker) Evaluates over a single considered time interval.

Methods inherited from interface agi.foundation.IEvaluator1

evaluate

Methods inherited from interface agi.foundation.IEvaluator

getCachingWrapper, getGroup, updateEvaluatorReferences

Methods inherited from interface agi.foundation.time.IAvailability

getAvailabilityIntervals, isAvailable

Methods inherited from interface agi.foundation.infrastructure.IThreadAware

getIsThreadSafe

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Method Detail

evaluate

@Nonnull
TResultOverIntervals evaluate(@Nonnull
                                        JulianDate start,
                                        @Nonnull
                                        JulianDate end)

Evaluates from the start date until the end date.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

start - The date to begin the evaluation.

end - The date to end the evaluation.

Returns:

The value of the function over the dates input.

evaluate

TResultOverIntervals evaluate(@Nonnull
                              JulianDate start,
                              @Nonnull
                              JulianDate end,
                              @Nullable
                              ITrackCalculationProgress tracker)

Evaluates from the start date until the end date. This evaluation also reports evaluation progress.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

start - The date to begin the evaluation.

end - The date to end the evaluation.

tracker - The tracker used for reporting progress of this evaluation.

Returns:

The value of the function over the dates input.

evaluate

@Nonnull
TResultOverIntervals evaluate(@Nonnull
                                        TimeInterval consideredInterval)

Evaluates over a single considered time interval.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

consideredInterval - The interval over which the evaluator is to analyze.

Returns:

The value of the function over the interval.

evaluate

TResultOverIntervals evaluate(@Nonnull
                              TimeInterval consideredInterval,
                              @Nullable
                              ITrackCalculationProgress tracker)

Evaluates over a single considered time interval. This evaluation also reports evaluation progress.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

consideredInterval - The interval over which the evaluator is to analyze.

tracker - The tracker used for reporting progress of this evaluation.

Returns:

The value of the function over the interval.

evaluate

@Nonnull
TResultOverIntervals evaluate(@Nonnull
                                        TimeIntervalCollection consideredIntervals)

Evaluates over the supplied time intervals.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

consideredIntervals - The set of time intervals over which the evaluator is to analyze.

Returns:

The value of the function over the intervals.

evaluate

TResultOverIntervals evaluate(@Nonnull
                              TimeIntervalCollection consideredIntervals,
                              @Nullable
                              ITrackCalculationProgress tracker)

Evaluates over the supplied time intervals. This evaluation also reports evaluation progress.

For information about the specific function evaluated by this evaluator, see the documentation for the method that was used to create this evaluator.

Once created, an evaluator will ignore changes made to the object(s) from which it was created. You should create a new evaluator after making changes to definitional objects in order for those changes to be reflected in the results.

Parameters:

consideredIntervals - The set of time intervals over which the evaluator is to analyze.

tracker - The tracker used for reporting progress of this evaluation.

Returns:

The value of the function over the intervals.