ContinuousFieldFunction class final

A function that returns a ContinuousField when evaluated.

Use ContinuousFieldFunction.evaluate to compute the result of this function.

Results are updated when changes are made to parameters of this function (or to parameters of functions from which it is composed).

Operator overloads are available via ContinuousFieldOperators to combine fields and values using *, +, -, /, and unary -.

Calculations that evaluate to infinity or NaN produce an indeterminate value.

Values are represented as 32-bit floating-point numbers, so arithmetic operations will wrap at the boundaries of this type.

Implemented types
Implementers
Available extensions

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

abs() → ContinuousFieldFunction
Composes a function that returns the absolute value of this function's field result across its extent.
acos() → ContinuousFieldFunction
Composes a function that returns the arccosine of this function's field result across its extent.
addOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that adds, point-wise, this function's field result and another across their spatial intersection.
addValue(double value) → ContinuousFieldFunction
Composes a function that adds, point-wise, a value to this function's field result across its extent.
asin() → ContinuousFieldFunction
Composes a function that returns the arcsine of this function's field result across its extent.
aspect() → ContinuousFieldFunction
Composes a function that returns the aspect of this function's field result across its extent.
atan() → ContinuousFieldFunction
Composes a function that returns the arctangent of this function's field result across its extent.
ceil() → ContinuousFieldFunction
Composes a function that rounds this function's field result, point-wise, upwards to the nearest integer across its extent.
clampOtherFields({required ContinuousFieldFunction minField, required ContinuousFieldFunction maxField}) → ContinuousFieldFunction
Composes a function that clamps, point-wise, this function's field result between two values drawn from two others.
clampValues({required double min, required double max}) → ContinuousFieldFunction
Composes a function that clamps, point-wise, this function's field result between two values.
clip(Envelope extent) → ContinuousFieldFunction
Composes a function that clips this function's field result such that it does not extend beyond the provided extent.
cos() → ContinuousFieldFunction
Composes a function that returns the cosine of this function's field result across its extent.
divideByOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that divides, point-wise, this function's field result by another across their spatial intersection.
divideByValue(double value) → ContinuousFieldFunction
Composes a function that divides, point-wise, this function's field result by a value across its extent.
evaluate() → Future<ContinuousField>
Evaluates the result of the function.
exp() → ContinuousFieldFunction
Composes a function that returns Euler's number (e) raised to this function's field result across its extent.
exp10() → ContinuousFieldFunction
Composes a function that returns 10 raised to this function's field result across its extent.
floor() → ContinuousFieldFunction
Composes a function that rounds this function's field result, point-wise, downwards to the nearest integer across its extent.
hasData() → BooleanFieldFunction
Composes a function that identifies, point-wise, where this function's field result has data across its extent.
isGreaterThanOrEqualToOtherField(ContinuousFieldFunction otherField) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is greater than or equal to another.
isGreaterThanOrEqualToValue(double value) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is greater than or equal to a given value.
isGreaterThanOtherField(ContinuousFieldFunction otherField) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is greater than another.
isGreaterThanValue(double value) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is greater than a given value.
isLessThanOrEqualToOtherField(ContinuousFieldFunction otherField) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is less than or equal to another.
isLessThanOrEqualToValue(double value) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is less than or equal to a given value.
isLessThanOtherField(ContinuousFieldFunction otherField) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is less than another.
isLessThanValue(double value) → BooleanFieldFunction
Composes a function that indicates if, point-wise, this function's field result is less than a given value.
log() → ContinuousFieldFunction
Composes a function that returns the natural logarithm of this function's field result across its extent.
log10() → ContinuousFieldFunction
Composes a function that returns the common logarithm (base 10) of this function's field result across its extent.
mask(BooleanFieldFunction selection) → ContinuousFieldFunction
Composes a function that applies a mask to this function's field result.
multiplyByOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that multiplies, point-wise, this function's field result and another across their spatial intersection.
multiplyByValue(double value) → ContinuousFieldFunction
Composes a function that multiplies, point-wise, this function's field result by a value across its extent.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
powOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that returns this function's field result raised to powers drawn from another field, point-wise, across their spatial intersection.
powValue(double power) → ContinuousFieldFunction
Composes a function that returns this function's field result raised to a power across its extent.
reciprocal() → ContinuousFieldFunction
Composes a function that returns the reciprocal of this function's field result across its extent.
remainderOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that applies a remainder operation, point-wise, to this function's field result using values from another field as the divisors across their spatial intersection.
remainderValue(double divisor) → ContinuousFieldFunction
Composes a function that applies a remainder operation, point-wise, to this function's field result.
replaceWithOtherFieldIf({required BooleanFieldFunction selection, required ContinuousFieldFunction otherField}) → ContinuousFieldFunction
Composes a function that preserves values from this function's field result or replaces them with values from another.
replaceWithValueIf({required BooleanFieldFunction selection, required double value}) → ContinuousFieldFunction
Composes a function that preserves values from this function's field result or replaces them with a constant value.
round() → ContinuousFieldFunction
Composes a function that rounds this function's field result, point-wise, to the nearest integer.
sin() → ContinuousFieldFunction
Composes a function that returns the sine of this function's field result across its extent.
slope() → ContinuousFieldFunction
Composes a function that returns the slope of this function's field result across its extent.
sqrt() → ContinuousFieldFunction
Composes a function that returns the square root of this function's field result across its extent.
subtractOtherField(ContinuousFieldFunction otherField) → ContinuousFieldFunction
Composes a function that subtracts, point-wise, another field from this function's field result across their spatial intersection.
subtractValue(double value) → ContinuousFieldFunction
Composes a function that subtracts, point-wise, a value from this function's field result across its extent.
tan() → ContinuousFieldFunction
Composes a function that returns the tangent of this function's field result across its extent.
toDiscreteFieldFunction() → DiscreteFieldFunction
Composes a function that casts, point-wise, float values from this function's field result to integer values across its extent.
toString() → String
A string representation of this object.
inherited

Operators

operator *(Object other) → ContinuousFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that multiplies, point-wise, this function's result by other, using ContinuousFieldFunction.multiplyByValue or ContinuousFieldFunction.multiplyByOtherField.
operator +(Object other) → ContinuousFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that adds, point-wise, other to this function's result, using ContinuousFieldFunction.addValue or ContinuousFieldFunction.addOtherField.
operator -(Object other) → ContinuousFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that subtracts, point-wise, other from this function's result, using ContinuousFieldFunction.subtractValue or ContinuousFieldFunction.subtractOtherField.
operator /(Object other) → ContinuousFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that divides, point-wise, this function's result by other, using ContinuousFieldFunction.divideByValue or ContinuousFieldFunction.divideByOtherField.
operator <(Object other) → BooleanFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that compares, point-wise, this function's result to other, using ContinuousFieldFunction.isLessThanValue or ContinuousFieldFunction.isLessThanOtherField.
operator <=(Object other) → BooleanFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that compares, point-wise, this function's result to other, using ContinuousFieldFunction.isLessThanOrEqualToValue or ContinuousFieldFunction.isLessThanOrEqualToOtherField.
operator ==(Object other) → bool
The equality operator.
inherited
operator >(Object other) → BooleanFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that compares, point-wise, this function's result to other, using ContinuousFieldFunction.isGreaterThanValue or ContinuousFieldFunction.isGreaterThanOtherField.
operator >=(Object other) → BooleanFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that compares, point-wise, this function's result to other, using ContinuousFieldFunction.isGreaterThanOrEqualToValue or ContinuousFieldFunction.isGreaterThanOrEqualToOtherField.
operator unary-() → ContinuousFieldFunction

Available on ContinuousFieldFunction, provided by the ContinuousFieldOperators extension

Composes a function that multiplies, point-wise, this function's result by -1.

Static Methods

create(ContinuousField result) → ContinuousFieldFunction
Creates a ContinuousFieldFunction with a predefined result.