T - the type of the field elementspublic class ArrayFieldVector<T extends FieldElement<T>> extends Object implements FieldVector<T>, Serializable
FieldVector interface with a FieldElement array.| Constructor and Description |
|---|
ArrayFieldVector(ArrayFieldVector<T> v)
Construct a vector from another vector, using a deep copy.
|
ArrayFieldVector(ArrayFieldVector<T> v1,
ArrayFieldVector<T> v2)
Deprecated.
as of 3.2, replaced by
ArrayFieldVector(FieldVector, FieldVector) |
ArrayFieldVector(ArrayFieldVector<T> v,
boolean deep)
Construct a vector from another vector.
|
ArrayFieldVector(ArrayFieldVector<T> v1,
T[] v2)
Deprecated.
as of 3.2, replaced by
ArrayFieldVector(FieldVector, FieldElement[]) |
ArrayFieldVector(Field<T> field)
Build a 0-length vector.
|
ArrayFieldVector(Field<T> field,
int size)
Construct a vector of zeroes.
|
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(FieldVector<T> v)
Construct a vector from another vector, using a deep copy.
|
ArrayFieldVector(FieldVector<T> v1,
FieldVector<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(int size,
T preset)
Construct a vector with preset values.
|
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(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.
|
| Modifier and Type | Method and Description |
|---|---|
ArrayFieldVector<T> |
add(ArrayFieldVector<T> v)
Compute the sum of
this and v. |
FieldVector<T> |
add(FieldVector<T> v)
Compute the sum of
this and v. |
ArrayFieldVector<T> |
append(ArrayFieldVector<T> v)
Construct a vector by appending a vector to this vector.
|
FieldVector<T> |
append(FieldVector<T> v)
Construct a vector by appending a vector to this vector.
|
FieldVector<T> |
append(T in)
Construct a vector by appending a T to this vector.
|
protected void |
checkVectorDimensions(FieldVector<T> v)
Check if instance and specified vectors have the same dimension.
|
protected void |
checkVectorDimensions(int n)
Check if instance dimension is equal to some expected value.
|
FieldVector<T> |
copy()
Returns a (deep) copy of this.
|
T |
dotProduct(ArrayFieldVector<T> v)
Compute the dot product.
|
T |
dotProduct(FieldVector<T> v)
Compute the dot product.
|
ArrayFieldVector<T> |
ebeDivide(ArrayFieldVector<T> v)
Element-by-element division.
|
FieldVector<T> |
ebeDivide(FieldVector<T> v)
Element-by-element division.
|
ArrayFieldVector<T> |
ebeMultiply(ArrayFieldVector<T> v)
Element-by-element multiplication.
|
FieldVector<T> |
ebeMultiply(FieldVector<T> v)
Element-by-element multiplication.
|
boolean |
equals(Object other)
Test for the equality of two vectors.
|
T[] |
getData()
Returns vector entries as a T array.
|
T[] |
getDataRef()
Returns a reference to the underlying data array.
|
int |
getDimension()
Returns the size of the vector.
|
T |
getEntry(int index)
Returns the entry in the specified index.
|
Field<T> |
getField()
Get the type of field elements of the vector.
|
FieldVector<T> |
getSubVector(int index,
int n)
Get a subvector from consecutive elements.
|
int |
hashCode()
Get a hashCode for the real vector.
|
FieldVector<T> |
mapAdd(T d)
Map an addition operation to each entry.
|
FieldVector<T> |
mapAddToSelf(T d)
Map an addition operation to each entry.
|
FieldVector<T> |
mapDivide(T d)
Map a division operation to each entry.
|
FieldVector<T> |
mapDivideToSelf(T d)
Map a division operation to each entry.
|
FieldVector<T> |
mapInv()
Map the 1/x function to each entry.
|
FieldVector<T> |
mapInvToSelf()
Map the 1/x function to each entry.
|
FieldVector<T> |
mapMultiply(T d)
Map a multiplication operation to each entry.
|
FieldVector<T> |
mapMultiplyToSelf(T d)
Map a multiplication operation to each entry.
|
FieldVector<T> |
mapSubtract(T d)
Map a subtraction operation to each entry.
|
FieldVector<T> |
mapSubtractToSelf(T d)
Map a subtraction operation to each entry.
|
FieldMatrix<T> |
outerProduct(ArrayFieldVector<T> v)
Compute the outer product.
|
FieldMatrix<T> |
outerProduct(FieldVector<T> v)
Compute the outer product.
|
ArrayFieldVector<T> |
projection(ArrayFieldVector<T> v)
Find the orthogonal projection of this vector onto another vector.
|
FieldVector<T> |
projection(FieldVector<T> v)
Find the orthogonal projection of this vector onto another vector.
|
void |
set(int index,
ArrayFieldVector<T> v)
Set a set of consecutive elements.
|
void |
set(T value)
Set all elements to a single value.
|
void |
setEntry(int index,
T value)
Set a single element.
|
void |
setSubVector(int index,
FieldVector<T> v)
Set a set of consecutive elements.
|
ArrayFieldVector<T> |
subtract(ArrayFieldVector<T> v)
Compute
this minus v. |
FieldVector<T> |
subtract(FieldVector<T> v)
Compute
this minus v. |
T[] |
toArray()
Convert the vector to a T array.
|
T |
walkInDefaultOrder(FieldVectorChangingVisitor<T> visitor)
Visits (and possibly alters) all entries of this vector in default order
(increasing index).
|
T |
walkInDefaultOrder(FieldVectorChangingVisitor<T> visitor,
int start,
int end)
Visits (and possibly alters) some entries of this vector in default order
(increasing index).
|
T |
walkInDefaultOrder(FieldVectorPreservingVisitor<T> visitor)
Visits (but does not alter) all entries of this vector in default order
(increasing index).
|
T |
walkInDefaultOrder(FieldVectorPreservingVisitor<T> visitor,
int start,
int end)
Visits (but does not alter) some entries of this vector in default order
(increasing index).
|
T |
walkInOptimizedOrder(FieldVectorChangingVisitor<T> visitor)
Visits (and possibly alters) all entries of this vector in optimized
order.
|
T |
walkInOptimizedOrder(FieldVectorChangingVisitor<T> visitor,
int start,
int end)
Visits (and possibly change) some entries of this vector in optimized
order.
|
T |
walkInOptimizedOrder(FieldVectorPreservingVisitor<T> visitor)
Visits (but does not alter) all entries of this vector in optimized
order.
|
T |
walkInOptimizedOrder(FieldVectorPreservingVisitor<T> visitor,
int start,
int end)
Visits (but does not alter) some entries of this vector in optimized
order.
|
public ArrayFieldVector(Field<T> field)
ArrayFieldVector(ArrayFieldVector, ArrayFieldVector) constructor
or one of the append methods (add(FieldVector) or
append(ArrayFieldVector)) to gather data into this vector.field - field to which the elements belongpublic ArrayFieldVector(Field<T> field, int size)
field - Field to which the elements belong.size - Size of the vector.public ArrayFieldVector(int size, T preset)
size - Size of the vector.preset - All entries will be set with this value.public ArrayFieldVector(T[] d) throws NullArgumentException, ZeroException
d array to retrieve
the field from its first element. This implies it cannot build
0 length vectors. To build vectors from any size, one should
use the ArrayFieldVector(Field, FieldElement[]) constructor.d - Array.NullArgumentException - if d is null.ZeroException - if d is empty.ArrayFieldVector(Field, FieldElement[])public ArrayFieldVector(Field<T> field, T[] d) throws NullArgumentException
field - Field to which the elements belong.d - Array.NullArgumentException - if d is null.ArrayFieldVector(FieldElement[])public ArrayFieldVector(T[] d, boolean copyArray) throws NullArgumentException, ZeroException
copyArray may be
set to false. This will prevent the copying and improve
performance as no new array will be built and no data will be copied.
This constructor needs a non-empty d array to retrieve
the field from its first element. This implies it cannot build
0 length vectors. To build vectors from any size, one should
use the ArrayFieldVector(Field, FieldElement[], boolean)
constructor.d - Data for the new vector.copyArray - If true, the input array will be copied,
otherwise it will be referenced.NullArgumentException - if d is null.ZeroException - if d is empty.ArrayFieldVector(FieldElement[]),
ArrayFieldVector(Field, FieldElement[], boolean)public ArrayFieldVector(Field<T> field, T[] d, boolean copyArray) throws NullArgumentException
copyArray may be
set to false. This will prevent the copying and improve
performance as no new array will be built and no data will be copied.field - Field to which the elements belong.d - Data for the new vector.copyArray - If true, the input array will be copied,
otherwise it will be referenced.NullArgumentException - if d is null.ArrayFieldVector(FieldElement[], boolean)public ArrayFieldVector(T[] d, int pos, int size) throws NullArgumentException, NumberIsTooLargeException
d - Array.pos - Position of the first entry.size - Number of entries to copy.NullArgumentException - if d is null.NumberIsTooLargeException - if the size of d is less
than pos + size.public ArrayFieldVector(Field<T> field, T[] d, int pos, int size) throws NullArgumentException, NumberIsTooLargeException
field - Field to which the elements belong.d - Array.pos - Position of the first entry.size - Number of entries to copy.NullArgumentException - if d is null.NumberIsTooLargeException - if the size of d is less
than pos + size.public ArrayFieldVector(FieldVector<T> v) throws NullArgumentException
v - Vector to copy.NullArgumentException - if v is null.public ArrayFieldVector(ArrayFieldVector<T> v) throws NullArgumentException
v - Vector to copy.NullArgumentException - if v is null.public ArrayFieldVector(ArrayFieldVector<T> v, boolean deep) throws NullArgumentException
v - Vector to copy.deep - If true perform a deep copy, otherwise perform
a shallow copyNullArgumentException - if v is null.@Deprecated public ArrayFieldVector(ArrayFieldVector<T> v1, ArrayFieldVector<T> v2) throws NullArgumentException
ArrayFieldVector(FieldVector, FieldVector)v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.public ArrayFieldVector(FieldVector<T> v1, FieldVector<T> v2) throws NullArgumentException
v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.@Deprecated public ArrayFieldVector(ArrayFieldVector<T> v1, T[] v2) throws NullArgumentException
ArrayFieldVector(FieldVector, FieldElement[])v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.public ArrayFieldVector(FieldVector<T> v1, T[] v2) throws NullArgumentException
v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.@Deprecated public ArrayFieldVector(T[] v1, ArrayFieldVector<T> v2) throws NullArgumentException
ArrayFieldVector(FieldElement[], FieldVector)v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.public ArrayFieldVector(T[] v1, FieldVector<T> v2) throws NullArgumentException
v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.public ArrayFieldVector(T[] v1, T[] v2) throws NullArgumentException, ZeroException
ArrayFieldVector(Field, FieldElement[], FieldElement[])
constructor.v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.ZeroException - if both arrays are empty.ArrayFieldVector(Field, FieldElement[], FieldElement[])public ArrayFieldVector(Field<T> field, T[] v1, T[] v2) throws NullArgumentException, ZeroException
field - Field to which the elements belong.v1 - First vector (will be put in front of the new vector).v2 - Second vector (will be put at back of the new vector).NullArgumentException - if v1 or v2 is
null.ZeroException - if both arrays are empty.ArrayFieldVector(FieldElement[], FieldElement[])public Field<T> getField()
getField in interface FieldVector<T extends FieldElement<T>>public FieldVector<T> copy()
copy in interface FieldVector<T extends FieldElement<T>>public FieldVector<T> add(FieldVector<T> v) throws DimensionMismatchException
this and v.add in interface FieldVector<T extends FieldElement<T>>v - vector to be addedthis + vDimensionMismatchException - if v is not the same size as thispublic ArrayFieldVector<T> add(ArrayFieldVector<T> v) throws DimensionMismatchException
this and v.v - vector to be addedthis + vDimensionMismatchException - if v is not the same size as
thispublic FieldVector<T> subtract(FieldVector<T> v) throws DimensionMismatchException
this minus v.subtract in interface FieldVector<T extends FieldElement<T>>v - vector to be subtractedthis - vDimensionMismatchException - if v is not the same size as thispublic ArrayFieldVector<T> subtract(ArrayFieldVector<T> v) throws DimensionMismatchException
this minus v.v - vector to be subtractedthis - vDimensionMismatchException - if v is not the same size as
thispublic FieldVector<T> mapAdd(T d) throws NullArgumentException
mapAdd in interface FieldVector<T extends FieldElement<T>>d - value to be added to each entrythis + dNullArgumentException - if d is null.public FieldVector<T> mapAddToSelf(T d) throws NullArgumentException
The instance is changed by this method.
mapAddToSelf in interface FieldVector<T extends FieldElement<T>>d - value to be added to each entrythisNullArgumentException - if d is null.public FieldVector<T> mapSubtract(T d) throws NullArgumentException
mapSubtract in interface FieldVector<T extends FieldElement<T>>d - value to be subtracted to each entrythis - dNullArgumentException - if d is nullpublic FieldVector<T> mapSubtractToSelf(T d) throws NullArgumentException
The instance is changed by this method.
mapSubtractToSelf in interface FieldVector<T extends FieldElement<T>>d - value to be subtracted to each entrythisNullArgumentException - if d is nullpublic FieldVector<T> mapMultiply(T d) throws NullArgumentException
mapMultiply in interface FieldVector<T extends FieldElement<T>>d - value to multiply all entries bythis * dNullArgumentException - if d is null.public FieldVector<T> mapMultiplyToSelf(T d) throws NullArgumentException
The instance is changed by this method.
mapMultiplyToSelf in interface FieldVector<T extends FieldElement<T>>d - value to multiply all entries bythisNullArgumentException - if d is null.public FieldVector<T> mapDivide(T d) throws NullArgumentException, MathArithmeticException
mapDivide in interface FieldVector<T extends FieldElement<T>>d - value to divide all entries bythis / dNullArgumentException - if d is null.MathArithmeticException - if d is zero.public FieldVector<T> mapDivideToSelf(T d) throws NullArgumentException, MathArithmeticException
The instance is changed by this method.
mapDivideToSelf in interface FieldVector<T extends FieldElement<T>>d - value to divide all entries bythisNullArgumentException - if d is null.MathArithmeticException - if d is zero.public FieldVector<T> mapInv() throws MathArithmeticException
mapInv in interface FieldVector<T extends FieldElement<T>>MathArithmeticException - if one of the entries is zero.public FieldVector<T> mapInvToSelf() throws MathArithmeticException
The instance is changed by this method.
mapInvToSelf in interface FieldVector<T extends FieldElement<T>>thisMathArithmeticException - if one of the entries is zero.public FieldVector<T> ebeMultiply(FieldVector<T> v) throws DimensionMismatchException
ebeMultiply in interface FieldVector<T extends FieldElement<T>>v - vector by which instance elements must be multipliedthis[i] * v[i] for all iDimensionMismatchException - if v is not the same size as thispublic ArrayFieldVector<T> ebeMultiply(ArrayFieldVector<T> v) throws DimensionMismatchException
v - vector by which instance elements must be multipliedthis[i] * v[i] for all iDimensionMismatchException - if v is not the same size as
thispublic FieldVector<T> ebeDivide(FieldVector<T> v) throws DimensionMismatchException, MathArithmeticException
ebeDivide in interface FieldVector<T extends FieldElement<T>>v - vector by which instance elements must be dividedthis[i] / v[i] for all iDimensionMismatchException - if v is not the same size as thisMathArithmeticException - if one entry of v is zero.public ArrayFieldVector<T> ebeDivide(ArrayFieldVector<T> v) throws DimensionMismatchException, MathArithmeticException
v - vector by which instance elements must be dividedthis[i] / v[i] for all iDimensionMismatchException - if v is not the same size as
thisMathArithmeticException - if one entry of v is zero.public T[] getData()
getData in interface FieldVector<T extends FieldElement<T>>public T[] getDataRef()
Does not make a fresh copy of the underlying data.
public T dotProduct(FieldVector<T> v) throws DimensionMismatchException
dotProduct in interface FieldVector<T extends FieldElement<T>>v - vector with which dot product should be computedthis and vDimensionMismatchException - if v is not the same size as thispublic T dotProduct(ArrayFieldVector<T> v) throws DimensionMismatchException
v - vector with which dot product should be computedthis and vDimensionMismatchException - if v is not the same size as
thispublic FieldVector<T> projection(FieldVector<T> v) throws DimensionMismatchException, MathArithmeticException
projection in interface FieldVector<T extends FieldElement<T>>v - vector onto which this must be projectedthis onto vDimensionMismatchException - if v is not the same size as thisMathArithmeticException - if v is the null vector.public ArrayFieldVector<T> projection(ArrayFieldVector<T> v) throws DimensionMismatchException, MathArithmeticException
v - vector onto which this must be projectedthis onto vDimensionMismatchException - if v is not the same size as
thisMathArithmeticException - if v is the null vector.public FieldMatrix<T> outerProduct(FieldVector<T> v)
outerProduct in interface FieldVector<T extends FieldElement<T>>v - vector with which outer product should be computedpublic FieldMatrix<T> outerProduct(ArrayFieldVector<T> v)
v - vector with which outer product should be computedpublic T getEntry(int index)
getEntry in interface FieldVector<T extends FieldElement<T>>index - Index location of entry to be fetched.index.FieldVector.setEntry(int, FieldElement)public int getDimension()
getDimension in interface FieldVector<T extends FieldElement<T>>public FieldVector<T> append(FieldVector<T> v)
append in interface FieldVector<T extends FieldElement<T>>v - vector to append to this one.public ArrayFieldVector<T> append(ArrayFieldVector<T> v)
v - vector to append to this one.public FieldVector<T> append(T in)
append in interface FieldVector<T extends FieldElement<T>>in - T to append.public FieldVector<T> getSubVector(int index, int n) throws OutOfRangeException, NotPositiveException
getSubVector in interface FieldVector<T extends FieldElement<T>>index - index of first element.n - number of elements to be retrieved.OutOfRangeException - if the index is not valid.NotPositiveException - if the number of elements if not positive.public void setEntry(int index, T value)
setEntry in interface FieldVector<T extends FieldElement<T>>index - element index.value - new value for the element.FieldVector.getEntry(int)public void setSubVector(int index, FieldVector<T> v) throws OutOfRangeException
setSubVector in interface FieldVector<T extends FieldElement<T>>index - index of first element to be set.v - vector containing the values to set.OutOfRangeException - if the index is not valid.public void set(int index, ArrayFieldVector<T> v) throws OutOfRangeException
index - index of first element to be set.v - vector containing the values to set.OutOfRangeException - if the index is invalid.public void set(T value)
set in interface FieldVector<T extends FieldElement<T>>value - single value to set for all elementspublic T[] toArray()
The array is independent from vector data, it's elements are copied.
toArray in interface FieldVector<T extends FieldElement<T>>protected void checkVectorDimensions(FieldVector<T> v) throws DimensionMismatchException
v - vector to compare instance withDimensionMismatchException - if the vectors do not
have the same dimensionsprotected void checkVectorDimensions(int n) throws DimensionMismatchException
n - Expected dimension.DimensionMismatchException - if the dimension is not equal to the
size of this vector.public T walkInDefaultOrder(FieldVectorPreservingVisitor<T> visitor)
visitor - the visitor to be used to process the entries of this
vectorFieldVectorPreservingVisitor.end()
at the end of the walkpublic T walkInDefaultOrder(FieldVectorPreservingVisitor<T> visitor, int start, int end) throws NumberIsTooSmallException, OutOfRangeException
visitor - visitor to be used to process the entries of this vectorstart - the index of the first entry to be visitedend - the index of the last entry to be visited (inclusive)FieldVectorPreservingVisitor.end()
at the end of the walkNumberIsTooSmallException - if end < start.OutOfRangeException - if the indices are not valid.public T walkInOptimizedOrder(FieldVectorPreservingVisitor<T> visitor)
visitor - the visitor to be used to process the entries of this
vectorFieldVectorPreservingVisitor.end()
at the end of the walkpublic T walkInOptimizedOrder(FieldVectorPreservingVisitor<T> visitor, int start, int end) throws NumberIsTooSmallException, OutOfRangeException
visitor - visitor to be used to process the entries of this vectorstart - the index of the first entry to be visitedend - the index of the last entry to be visited (inclusive)FieldVectorPreservingVisitor.end()
at the end of the walkNumberIsTooSmallException - if end < start.OutOfRangeException - if the indices are not valid.public T walkInDefaultOrder(FieldVectorChangingVisitor<T> visitor)
visitor - the visitor to be used to process and modify the entries
of this vectorFieldVectorChangingVisitor.end()
at the end of the walkpublic T walkInDefaultOrder(FieldVectorChangingVisitor<T> visitor, int start, int end) throws NumberIsTooSmallException, OutOfRangeException
visitor - visitor to be used to process the entries of this vectorstart - the index of the first entry to be visitedend - the index of the last entry to be visited (inclusive)FieldVectorChangingVisitor.end()
at the end of the walkNumberIsTooSmallException - if end < start.OutOfRangeException - if the indices are not valid.public T walkInOptimizedOrder(FieldVectorChangingVisitor<T> visitor)
visitor - the visitor to be used to process the entries of this
vectorFieldVectorChangingVisitor.end()
at the end of the walkpublic T walkInOptimizedOrder(FieldVectorChangingVisitor<T> visitor, int start, int end) throws NumberIsTooSmallException, OutOfRangeException
visitor - visitor to be used to process the entries of this vectorstart - the index of the first entry to be visitedend - the index of the last entry to be visited (inclusive)FieldVectorChangingVisitor.end()
at the end of the walkNumberIsTooSmallException - if end < start.OutOfRangeException - if the indices are not valid.Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.