Package org.hipparchus.util

Interface FieldBlendable<B,T extends FieldElement<T>>

Type Parameters:
B - blendable class
T - type of the field element
All Known Subinterfaces:
FieldMatrix<T>
All Known Implementing Classes:
AbstractFieldMatrix, Array2DRowFieldMatrix, BlockFieldMatrix, FieldVector3D, SparseFieldMatrix
public interface FieldBlendable<B,T extends FieldElement<T>>
Interface representing classes that can blend with other instances of themselves using a given blending value.

The blending value is commonly given from a smoothstep function.

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    blendArithmeticallyWith(B other, T blendingValue)
    Blend arithmetically this instance with another one.

  • Method Details

    • blendArithmeticallyWith

      B blendArithmeticallyWith(B other, T blendingValue) throws MathIllegalArgumentException
      Blend arithmetically this instance with another one.
      Parameters:
      other - other instance to blend arithmetically with
      blendingValue - value from smoothstep function B(x). It is expected to be between [0:1] and will throw an exception otherwise.
      Returns:
      this * (1 - B(x)) + other * B(x)
      Throws:
      MathIllegalArgumentException - if blending value is not within [0:1]