Uses of Interface org.apache.commons.math3.FieldElement (Apache Commons Math 3.3 API)

## Uses of Interface
org.apache.commons.math3.FieldElement

- Packages that use FieldElement
  Package | Description
  --- | ---
  org.apache.commons.math3 | Common classes used throughout the commons-math library.
  org.apache.commons.math3.analysis.differentiation | This package holds the main interfaces and basic building block classes dealing with differentiation.
  org.apache.commons.math3.analysis.interpolation | Univariate real functions interpolation algorithms.
  org.apache.commons.math3.complex | Complex number type and implementations of complex transcendental functions.
  org.apache.commons.math3.dfp | Decimal floating point library for Java
  org.apache.commons.math3.fraction | Fraction number type and fraction number formatting.
  org.apache.commons.math3.linear | Linear algebra support.
  org.apache.commons.math3.util | Convenience routines and common data structures used throughout the commons-math library.

- - ### Uses of FieldElement in org.apache.commons.math3

    Subinterfaces of FieldElement in org.apache.commons.math3
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `RealFieldElement<T>` Interface representing a real field.

    Methods in org.apache.commons.math3 that return types with arguments of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `Class<? extends FieldElement<T>>` | Field.`getRuntimeClass()` Returns the runtime class of the FieldElement.

  - ### Uses of FieldElement in org.apache.commons.math3.analysis.differentiation

    Classes in org.apache.commons.math3.analysis.differentiation that implement FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DerivativeStructure` Class representing both the value and the differentials of a function.
    `class` | `SparseGradient` First derivative computation with large number of variables.

  - ### Uses of FieldElement in org.apache.commons.math3.analysis.interpolation

    Classes in org.apache.commons.math3.analysis.interpolation with type parameters of type FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FieldHermiteInterpolator<T extends FieldElement<T>>` Polynomial interpolator using both sample values and sample derivatives.

    Methods in org.apache.commons.math3.analysis.interpolation that return FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `T[][]` | FieldHermiteInterpolator.`derivatives(T x, int order)` Interpolate value and first derivatives at a specified abscissa.
    `T[]` | FieldHermiteInterpolator.`value(T x)` Interpolate value at a specified abscissa.

    Methods in org.apache.commons.math3.analysis.interpolation with parameters of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | FieldHermiteInterpolator.`addSamplePoint(T x, T[]... value)` Add a sample point.

  - ### Uses of FieldElement in org.apache.commons.math3.complex

    Classes in org.apache.commons.math3.complex that implement FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Complex` Representation of a Complex number, i.e.

    Methods in org.apache.commons.math3.complex that return types with arguments of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `Class<? extends FieldElement<Complex>>` | ComplexField.`getRuntimeClass()` Returns the runtime class of the FieldElement.

  - ### Uses of FieldElement in org.apache.commons.math3.dfp

    Classes in org.apache.commons.math3.dfp that implement FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Dfp` Decimal floating point library for Java
    `class` | `DfpDec` Subclass of `Dfp` which hides the radix-10000 artifacts of the superclass.

    Methods in org.apache.commons.math3.dfp that return types with arguments of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `Class<? extends FieldElement<Dfp>>` | DfpField.`getRuntimeClass()` Returns the runtime class of the FieldElement.

  - ### Uses of FieldElement in org.apache.commons.math3.fraction

    Classes in org.apache.commons.math3.fraction that implement FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BigFraction` Representation of a rational number without any overflow.
    `class` | `Fraction` Representation of a rational number.

    Methods in org.apache.commons.math3.fraction that return types with arguments of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `Class<? extends FieldElement<BigFraction>>` | BigFractionField.`getRuntimeClass()` Returns the runtime class of the FieldElement.
    `Class<? extends FieldElement<Fraction>>` | FractionField.`getRuntimeClass()` Returns the runtime class of the FieldElement.

  - ### Uses of FieldElement in org.apache.commons.math3.linear

    Classes in org.apache.commons.math3.linear with type parameters of type FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractFieldMatrix<T extends FieldElement<T>>` Basic implementation of `FieldMatrix` methods regardless of the underlying storage.
    `class` | `Array2DRowFieldMatrix<T extends FieldElement<T>>` Implementation of FieldMatrix using a `FieldElement`[][] array to store entries.
    `class` | `ArrayFieldVector<T extends FieldElement<T>>` This class implements the `FieldVector` interface with a `FieldElement` array.
    `class` | `BlockFieldMatrix<T extends FieldElement<T>>` Cache-friendly implementation of FieldMatrix using a flat arrays to store square blocks of the matrix.
    `class` | `DefaultFieldMatrixChangingVisitor<T extends FieldElement<T>>` Default implementation of the `FieldMatrixChangingVisitor` interface.
    `class` | `DefaultFieldMatrixPreservingVisitor<T extends FieldElement<T>>` Default implementation of the `FieldMatrixPreservingVisitor` interface.
    `interface` | `FieldDecompositionSolver<T extends FieldElement<T>>` Interface handling decomposition algorithms that can solve A × X = B.
    `class` | `FieldLUDecomposition<T extends FieldElement<T>>` Calculates the LUP-decomposition of a square matrix.
    `interface` | `FieldMatrix<T extends FieldElement<T>>` Interface defining field-valued matrix with basic algebraic operations.
    `interface` | `FieldMatrixChangingVisitor<T extends FieldElement<?>>` Interface defining a visitor for matrix entries.
    `interface` | `FieldMatrixPreservingVisitor<T extends FieldElement<?>>` Interface defining a visitor for matrix entries.
    `interface` | `FieldVector<T extends FieldElement<T>>` Interface defining a field-valued vector with basic algebraic operations.
    `interface` | `FieldVectorChangingVisitor<T extends FieldElement<?>>` This interface defines a visitor for the entries of a vector.
    `interface` | `FieldVectorPreservingVisitor<T extends FieldElement<?>>` This interface defines a visitor for the entries of a vector.
    `class` | `SparseFieldMatrix<T extends FieldElement<T>>` Sparse matrix implementation based on an open addressed map.
    `class` | `SparseFieldVector<T extends FieldElement<T>>` This class implements the `FieldVector` interface with a `OpenIntToFieldHashMap` backing store.

    Methods in org.apache.commons.math3.linear with type parameters of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `protected static <T extends FieldElement<T>> T[]` | AbstractFieldMatrix.`buildArray(Field<T> field, int length)` Deprecated. as of 3.2, replaced by `MathArrays.buildArray(Field, int)`
    `protected static <T extends FieldElement<T>> T[][]` | AbstractFieldMatrix.`buildArray(Field<T> field, int rows, int columns)` Deprecated. as of 3.2, replaced by `MathArrays.buildArray(Field, int, int)`
    `static <T extends FieldElement<T>> T[][]` | BlockFieldMatrix.`createBlocksLayout(Field<T> field, int rows, int columns)` Create a data array in blocks layout.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createColumnFieldMatrix(T[] columnData)` Creates a column `FieldMatrix` using the data from the input array.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldDiagonalMatrix(T[] diagonal)` Returns a diagonal matrix with specified elements.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldIdentityMatrix(Field<T> field, int dimension)` Returns `dimension x dimension` identity matrix.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldMatrix(Field<T> field, int rows, int columns)` Returns a `FieldMatrix` with specified dimensions.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldMatrix(T[][] data)` Returns a `FieldMatrix` whose entries are the the values in the the input array.
    `static <T extends FieldElement<T>> FieldVector<T>` | MatrixUtils.`createFieldVector(T[] data)` Creates a `FieldVector` using the data from the input array.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createRowFieldMatrix(T[] rowData)` Create a row `FieldMatrix` using the data from the input array.
    `protected static <T extends FieldElement<T>> Field<T>` | AbstractFieldMatrix.`extractField(T[] d)` Get the elements type from an array.
    `protected static <T extends FieldElement<T>> Field<T>` | AbstractFieldMatrix.`extractField(T[][] d)` Get the elements type from an array.
    `static <T extends FieldElement<T>> T[][]` | BlockFieldMatrix.`toBlocksLayout(T[][] rawData)` Convert a data array from raw layout to blocks layout.

    Methods in org.apache.commons.math3.linear that return FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `protected static <T extends FieldElement<T>> T[]` | AbstractFieldMatrix.`buildArray(Field<T> field, int length)` Deprecated. as of 3.2, replaced by `MathArrays.buildArray(Field, int)`
    `protected static <T extends FieldElement<T>> T[][]` | AbstractFieldMatrix.`buildArray(Field<T> field, int rows, int columns)` Deprecated. as of 3.2, replaced by `MathArrays.buildArray(Field, int, int)`
    `static <T extends FieldElement<T>> T[][]` | BlockFieldMatrix.`createBlocksLayout(Field<T> field, int rows, int columns)` Create a data array in blocks layout.
    `T[]` | BlockFieldMatrix.`getColumn(int column)` Get the entries in column number `col` as an array.
    `T[]` | FieldMatrix.`getColumn(int column)` Get the entries in column number `col` as an array.
    `T[]` | AbstractFieldMatrix.`getColumn(int column)` Get the entries in column number `col` as an array.
    `T[][]` | BlockFieldMatrix.`getData()` Returns matrix entries as a two-dimensional array.
    `T[][]` | FieldMatrix.`getData()` Returns matrix entries as a two-dimensional array.
    `T[][]` | AbstractFieldMatrix.`getData()` Returns matrix entries as a two-dimensional array.
    `T[]` | ArrayFieldVector.`getData()` Returns vector entries as a T array.
    `T[]` | SparseFieldVector.`getData()` Deprecated. as of 3.1, to be removed in 4.0. Please use the `SparseFieldVector.toArray()` method instead.
    `T[]` | FieldVector.`getData()` Deprecated. as of 3.1, to be removed in 4.0. Please use the `FieldVector.toArray()` method instead.
    `T[][]` | Array2DRowFieldMatrix.`getData()` Returns matrix entries as a two-dimensional array.
    `T[]` | ArrayFieldVector.`getDataRef()` Returns a reference to the underlying data array.
    `T[][]` | Array2DRowFieldMatrix.`getDataRef()` Get a reference to the underlying data array.
    `T[]` | BlockFieldMatrix.`getRow(int row)` Get the entries in row number `row` as an array.
    `T[]` | FieldMatrix.`getRow(int row)` Get the entries in row number `row` as an array.
    `T[]` | AbstractFieldMatrix.`getRow(int row)` Get the entries in row number `row` as an array.
    `T[]` | BlockFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | FieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | AbstractFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | Array2DRowFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | BlockFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | FieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | AbstractFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | Array2DRowFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | ArrayFieldVector.`toArray()` Convert the vector to a T array.
    `T[]` | SparseFieldVector.`toArray()` Convert the vector to a T array.
    `T[]` | FieldVector.`toArray()` Convert the vector to a T array.
    `static <T extends FieldElement<T>> T[][]` | BlockFieldMatrix.`toBlocksLayout(T[][] rawData)` Convert a data array from raw layout to blocks layout.

    Methods in org.apache.commons.math3.linear with parameters of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | FieldMatrix.`copySubMatrix(int[] selectedRows, int[] selectedColumns, T[][] destination)` Copy a submatrix.
    `void` | AbstractFieldMatrix.`copySubMatrix(int[] selectedRows, int[] selectedColumns, T[][] destination)` Copy a submatrix.
    `void` | FieldMatrix.`copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, T[][] destination)` Copy a submatrix.
    `void` | AbstractFieldMatrix.`copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, T[][] destination)` Copy a submatrix.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createColumnFieldMatrix(T[] columnData)` Creates a column `FieldMatrix` using the data from the input array.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldDiagonalMatrix(T[] diagonal)` Returns a diagonal matrix with specified elements.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createFieldMatrix(T[][] data)` Returns a `FieldMatrix` whose entries are the the values in the the input array.
    `static <T extends FieldElement<T>> FieldVector<T>` | MatrixUtils.`createFieldVector(T[] data)` Creates a `FieldVector` using the data from the input array.
    `static <T extends FieldElement<T>> FieldMatrix<T>` | MatrixUtils.`createRowFieldMatrix(T[] rowData)` Create a row `FieldMatrix` using the data from the input array.
    `protected static <T extends FieldElement<T>> Field<T>` | AbstractFieldMatrix.`extractField(T[] d)` Get the elements type from an array.
    `protected static <T extends FieldElement<T>> Field<T>` | AbstractFieldMatrix.`extractField(T[][] d)` Get the elements type from an array.
    `T[]` | BlockFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | FieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | AbstractFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | Array2DRowFieldMatrix.`operate(T[] v)` Returns the result of multiplying this by the vector `v`.
    `T[]` | BlockFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | FieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | AbstractFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `T[]` | Array2DRowFieldMatrix.`preMultiply(T[] v)` Returns the (row) vector result of premultiplying this by the vector `v`.
    `void` | BlockFieldMatrix.`setColumn(int column, T[] array)` Set the entries in column number `column` as a column matrix.
    `void` | FieldMatrix.`setColumn(int column, T[] array)` Set the entries in column number `column` as a column matrix.
    `void` | AbstractFieldMatrix.`setColumn(int column, T[] array)` Set the entries in column number `column` as a column matrix.
    `void` | BlockFieldMatrix.`setRow(int row, T[] array)` Set the entries in row number `row` as a row matrix.
    `void` | FieldMatrix.`setRow(int row, T[] array)` Set the entries in row number `row` as a row matrix.
    `void` | AbstractFieldMatrix.`setRow(int row, T[] array)` Set the entries in row number `row` as a row matrix.
    `void` | BlockFieldMatrix.`setSubMatrix(T[][] subMatrix, int row, int column)` Replace the submatrix starting at `(row, column)` using data in the input `subMatrix` array.
    `void` | FieldMatrix.`setSubMatrix(T[][] subMatrix, int row, int column)` Replace the submatrix starting at `(row, column)` using data in the input `subMatrix` array.
    `void` | AbstractFieldMatrix.`setSubMatrix(T[][] subMatrix, int row, int column)` Replace the submatrix starting at `(row, column)` using data in the input `subMatrix` array.
    `void` | Array2DRowFieldMatrix.`setSubMatrix(T[][] subMatrix, int row, int column)` Replace the submatrix starting at `(row, column)` using data in the input `subMatrix` array.
    `static <T extends FieldElement<T>> T[][]` | BlockFieldMatrix.`toBlocksLayout(T[][] rawData)` Convert a data array from raw layout to blocks layout.

    Constructors in org.apache.commons.math3.linear with parameters of type FieldElement
    Constructor and Description
    `Array2DRowFieldMatrix(Field<T> field, T[] v)` Create a new (column) `FieldMatrix<T>` using `v` as the data for the unique column of the created matrix.
    `Array2DRowFieldMatrix(Field<T> field, T[][] d)` Create a new `FieldMatrix<T>` using the input array as the underlying data array.
    `Array2DRowFieldMatrix(Field<T> field, T[][] d, boolean copyArray)` Create a new `FieldMatrix<T>` using the input array as the underlying data array.
    `Array2DRowFieldMatrix(T[] v)` Create a new (column) `FieldMatrix<T>` using `v` as the data for the unique column of the created matrix.
    `Array2DRowFieldMatrix(T[][] d)` Create a new `FieldMatrix<T>` using the input array as the underlying data array.
    `Array2DRowFieldMatrix(T[][] d, boolean copyArray)` Create a new `FieldMatrix<T>` using the input array as the underlying data array.
    `ArrayFieldVector(ArrayFieldVector<T> v1, T[] v2)` Deprecated. as of 3.2, replaced by `ArrayFieldVector.ArrayFieldVector(FieldVector, FieldElement[])`
    `ArrayFieldVector(Field<T> field, T[] d)` Construct a vector from an array, copying the input array.
    `ArrayFieldVector(Field<T> field, T[] d, boolean copyArray)` Create a new ArrayFieldVector using the input array as the underlying data array.
    `ArrayFieldVector(Field<T> field, T[] d, int pos, int size)` Construct a vector from part of a array.
    `ArrayFieldVector(Field<T> field, T[] v1, T[] v2)` Construct a vector by appending one vector to another vector.
    `ArrayFieldVector(Field<T> field, T[] v1, T[] v2)` Construct a vector by appending one vector to another vector.
    `ArrayFieldVector(FieldVector<T> v1, T[] v2)` Construct a vector by appending one vector to another vector.
    `ArrayFieldVector(T[] d)` Construct a vector from an array, copying the input array.
    `ArrayFieldVector(T[] v1, ArrayFieldVector<T> v2)` Deprecated. as of 3.2, replaced by `ArrayFieldVector.ArrayFieldVector(FieldElement[], FieldVector)`
    `ArrayFieldVector(T[] d, boolean copyArray)` Create a new ArrayFieldVector using the input array as the underlying data array.
    `ArrayFieldVector(T[] v1, FieldVector<T> v2)` Construct a vector by appending one vector to another vector.
    `ArrayFieldVector(T[] d, int pos, int size)` Construct a vector from part of a array.
    `ArrayFieldVector(T[] v1, T[] v2)` Construct a vector by appending one vector to another vector.
    `ArrayFieldVector(T[] v1, T[] v2)` Construct a vector by appending one vector to another vector.
    `BlockFieldMatrix(int rows, int columns, T[][] blockData, boolean copyArray)` Create a new dense matrix copying entries from block layout data.
    `BlockFieldMatrix(T[][] rawData)` Create a new dense matrix copying entries from raw layout data.
    `SparseFieldVector(Field<T> field, T[] values)` Create from a Field array.

  - ### Uses of FieldElement in org.apache.commons.math3.util

    Classes in org.apache.commons.math3.util with type parameters of type FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `OpenIntToFieldHashMap<T extends FieldElement<T>>` Open addressed map from int to FieldElement.

    Classes in org.apache.commons.math3.util that implement FieldElement
    Modifier and Type | Class and Description
    --- | ---
    `class` | `BigReal` Arbitrary precision decimal number.
    `class` | `Decimal64` This class wraps a `double` value in an object.

    Methods in org.apache.commons.math3.util that return types with arguments of type FieldElement
    Modifier and Type | Method and Description
    --- | ---
    `Class<? extends FieldElement<Decimal64>>` | Decimal64Field.`getRuntimeClass()` Returns the runtime class of the FieldElement.
    `Class<? extends FieldElement<BigReal>>` | BigRealField.`getRuntimeClass()` Returns the runtime class of the FieldElement.

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.