jv.vecmath
Class PiVector

java.lang.Object
  |
  +--jv.vecmath.P_Vector
        |
        +--jv.vecmath.PiVector

All Implemented Interfaces:

java.io.Serializable

public class PiVector

extends P_Vector

Linear algebra class for an array of integers with variable length.

Version:

08.11.00, 1.70 revised (kp) Replace string formatting routines of Fmt with PuString.
29.08.00, 1.60 revised (ur) Sort methods and hasUniqueEntries method added.
29.08.97, 1.50 revised (kp) Many additional methods from PdVector added.
00.00.97, 1.00 created (kp)

Author:

Konrad Polthier

See Also:

Serialized Form

Field Summary

int[]

m_data Data array containing the components of the vector.

Constructor Summary

PiVector()
Constructor, should only be used by experts, usually call PiVector(int aSize).

PiVector(int aSize)
Constructor creating a vector with given dimension.

PiVector(int[] x)
Constructs a vector having same length and given initial data as given array.

PiVector(int x, int y)
Constructs a vector of length 2 and given initial data.

PiVector(int x, int y, int z)
Constructs a vector of length 3 and given initial data.

PiVector(int x, int y, int z, int w)
Constructs a vector of length 4 and given initial data.

Method Summary

void	add(int val) Add argument to each component of vector.
void	add(PiVector m) Sum with argument vector this = this+m.
void	add(PiVector m1, PiVector m2) Sum of argument vectors this = m1+m2.
int	addEntry(int val) Add another entry at the end of the vector and increment size of vector.
void	blend(int a, PiVector v, int b, PiVector w) Interpolate between two vectors with given weights.
void	blendBase(PiVector v, int b, PiVector w) Interpolate between two vectors with given weights.
static PiVector	blendNew(int a, PiVector v, int b, PiVector w) Create a new vector this = a*v + b*w.
int	changeValue(int oldValue, int newValue) Change all occurrence of value oldValue to newValue COMPARE: changeValue(int, int, int) return number of changed positions
int	changeValue(int usedSize, int oldValue, int newValue) Change occurrence of value oldValue to newValue on first 'usedSize' positions difference to method changeValue(int, int): sometime we use vectors where only the first entries are used.
java.lang.Object	clone() Duplicate vector and data array.
void	copy(int[] anArray, int aSize) Copy a integer array into a vector, and do not adjust size of dest vector.
boolean	copy(int destInd, PiVector dataSrc, int srcInd, int size) Copy part of a vector into a vector, and adjust size of dest vector only it is too small.
void	copy(PiVector v) Copy a vector into a vector, and do not adjust size of dest vector.
static boolean	copy(PiVector[] dataDest, int destInd, PiVector[] dataSrc, int srcInd, int size) Copies some vectors of a given array of vectors into an existing destination array.
void	copyArray(PiVector v) Copy data array of source vector into this vector, and do not adjust size of dest vector.
static PiVector[]	copyNew(int[][] data) Create an new array with copies of all doubles of a given 2-dimensional array of numbers.
static PiVector	copyNew(PiVector v) Create a new vector as clone of argument vector.
static PiVector[]	copyNew(PiVector[] data) Create an new array with copies of all vectors of a given array of vectors.
static PiVector[]	copyNew(PiVector[] data, int size) Create an new array with copies of the first 'size' vectors of a given array of vectors.
int	dist(PiVector v) Euclidean distance dist = |this-v|.
int	dot(PiVector v) Compute scalar product with argument vector.
static int	dot(PiVector v, PiVector w) Scalar product of two vectors.
boolean	equals(int[] list) Compare vector with list of integers and return false if different array lengths or a different entry.
boolean	equals(PiVector vec) Determines whether another vector is equal to this vector.
int[]	getEntries() Return a copy of content of vector as array of integers.
static int[][]	getEntries(PiVector[] vArr) Return content of array of vectors as matrix of integers.
int	getEntry(int ind) Get the component of a vector.
int	getFirstEntry() Get the first component of a vector.
int	getIndexOf(int aValue) Find index of first occurrence of value 'aValue' in vector.
int	getLastEntry() Get the last component of a vector.
static int	getSameSize(PiVector[] vecArray, int numUsed) Check of all vectors in array of vector have same length.
int	getSize() Return size of vector, i.e. number of entries in data array.
boolean	hasUniqueEntries() Check, whether all entrys of this vector are different.
int	indexOfAbsMax() Find component in vector with maximal absolute value.
int	indexOfAbsMin() Find component in vector with minimal absolute value.
int	indexOfMax() Find component in vector with maximal value.
int	indexOfMin() Find component in vector with minimal value.
void	invert() Invert order of all entries, i.e. the first entry becomes the last entry.
void	invert(int usedSize) Invert order of the first 'usedSize' entries, i.e. the first entry becomes the 'usedSize-1' entry.
void	leftMultMatrix(PdMatrix m) Multiply vector with matrix this = m*this.
void	leftMultMatrix(PdMatrix m, PiVector v) Multiply vector with matrix this = m*v.
int	length() Get euclidean length of vector.
int	max() Find maximum value in vector.
static boolean	max(PiVector max, PiVector[] aVecArray, int arrayLength) Find the maximum of an array of vectors in each component.
double	maxAbs() Find maximal absolute value of component in vector.
int	min() Find minimal value of component in vector.
static boolean	min(PiVector min, PiVector[] aVecArray, int arrayLength) Find the minimum of an array of vectors in each component.
void	multScalar(int scalar) Multiply vector with scalar this = scalar*this.
void	multScalar(PiVector v, int scalar) Multiply argument vector with scalar this = scalar*v.
boolean	normalize() Normalize vector to unit length.
void	normalize(PiVector v) Set vector to normalized argument vector.
static PiVector[]	realloc(PiVector[] data, int arraySize) Allocate an array of vectors, where all vectors have the same dimension.
static PiVector[]	realloc(PiVector[] data, int arraySize, int vectorSize) Allocate an array of vectors, where all vectors have the same dimension.
void	rightMultMatrix(PdMatrix m) Multiply vector with matrix this = this*m.
void	rightMultMatrix(PiVector v, PdMatrix m) Multiply vector with matrix this = v*m.
void	set(int x) Assign value to vector, and set size of vector to 1.
void	set(int[] x) Assign values of vector, and adjust length of vector if different from length of array.
void	set(int[] x, int len) Assign first values of array to vector, and adjust length of vector if different from argument len.
void	set(int[] x, int from, int len) Assign 'len' values of array starting at 'from' to vector, and adjust length of vector if different from argument len.
void	set(int x, int y) Assign value to vector, and set size of vector to 2.
void	set(int x, int y, int z) Assign value to vector, and set size of vector to 3.
void	set(int x, int y, int z, int w) Assign value to vector, and set size of vector to 4.
void	set(PiVector x, int from, int len) Assign 'len' values of array starting at 'from' to vector, and adjust length of vector if different from argument len.
void	setConstant(int aValue) Set all entries to a constant value.
static void	setConstant(PiVector[] aVecArray, int aValue) Set all components of all vectors of an array to a constant.
static void	setConstant(PiVector[] aVecArray, int[] data) Set all vectors of an array equal to a given vector.
static void	setConstant(PiVector[] aVecArray, PiVector aVector) Set all vectors of an array equal to a given vector.
static void	setConstant(PiVector v, int aValue) Set all entries to a constant value.
void	setEntry(int ind, int value) Assign value to component of vector, and possibly enlarge vector if too small.
void	setFirstEntry(int value) Set the first component of a vector.
void	setLastEntry(int value) Set the last component of a vector.
void	setLength(int aLength) Set euclidean length of vector.
int	setSize(int aSize) Set dimension of vector, i.e. length of its data array.
void	shift(int num) Shift components in cyclic order within the array.
void	sort() Sort entries of this PiVector by size.
void	sort(PiVector vecOut) Fill OutVector with sorted entries of this PiVector.
int	sqrDist(PiVector v) Square of euclidean distance sqrDist = |this-v|^2.
int	sqrLength() Get square of euclidean length of vector.
void	sub(PiVector m) Difference with argument vector this = this-m.
void	sub(PiVector m1, PiVector m2)
static PiVector	subNew(PiVector m1, PiVector m2) Create a new vector as difference of argument vectors new = m1-m2.
java.lang.String	toShortString() Create a single-line string representation of the vector components and attributes.
java.lang.String	toString() Create a multi-line string representation with detailed information about all instance variables.

Methods inherited from class jv.vecmath.P_Vector

clearTag, clone, clone, copy, getBits, getName, hasTag, setName, setTag

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_data

public int[] m_data

Data array containing the components of the vector. Array has public access for efficiency reasons in numerical computations, although method access should be preferred. Do not modify length of array directly.

Constructor Detail

PiVector

public PiVector()

Constructor, should only be used by experts, usually call PiVector(int aSize).

PiVector

public PiVector(int aSize)

Constructor creating a vector with given dimension. The length of the integer array is 'aSize', no initialization performed.

PiVector

public PiVector(int x,
                int y)

Constructs a vector of length 2 and given initial data.

PiVector

public PiVector(int x,
                int y,
                int z)

Constructs a vector of length 3 and given initial data.

PiVector

public PiVector(int x,
                int y,
                int z,
                int w)

Constructs a vector of length 4 and given initial data.

PiVector

public PiVector(int[] x)

Constructs a vector having same length and given initial data as given array.

Method Detail

clone

public java.lang.Object clone()

Duplicate vector and data array. Method just returns result of copyNew(PiVector).

See Also:

copyNew(PiVector)

getEntries

public static int[][] getEntries(PiVector[] vArr)

Return content of array of vectors as matrix of integers.

Parameters:

vArr - Array of vectors

Returns:

2-dimensional matrix of integers

realloc

public static final PiVector[] realloc(PiVector[] data,
                                       int arraySize,
                                       int vectorSize)

Allocate an array of vectors, where all vectors have the same dimension. If argument data!=null then as most as possible of the content of existing vectors is copied into (possibly reused) vectors of the reallocated array.

If requested array size is 0 then method returns an array of length 0.

Parameters:

data - possibly empty array of vectors

arraySize - number of vectors in new array

vectorSize - dimension of vectors in new array

See Also:

realloc(PiVector [], int)

realloc

public static final PiVector[] realloc(PiVector[] data,
                                       int arraySize)

Allocate an array of vectors, where all vectors have the same dimension. If argument data!=null then as most as possible of the existing vectors are reused in the reallocated array.

If requested array size is 0 then method returns an array of length 0.

Parameters:

data - possibly empty array of vectors

arraySize - number of vectors in new array

See Also:

realloc(PiVector [], int, int)

copyNew

public static PiVector[] copyNew(int[][] data)

Create an new array with copies of all doubles of a given 2-dimensional array of numbers. Each row of argument vector is stored in a vector. Rows may have different length. A row with length zero leads to a warning message, and allocates a vector with length zero.

Parameters:

data - 2-dimensional array of numbers

Returns:

new array with same number of vectors as rows of argument array

See Also:

copyNew(PiVector [], int), copy(PiVector [], int, PiVector [], int, int)

copyNew

public static PiVector[] copyNew(PiVector[] data)

Create an new array with copies of all vectors of a given array of vectors. The new array contains new vectors containing the same data as the original vectors.

Parameters:

data - array of vectors

Returns:

new array with same number of vectors as argument array

See Also:

copyNew(PiVector [], int), copy(PiVector [], int, PiVector [], int, int)

copyNew

public static PiVector[] copyNew(PiVector[] data,
                                 int size)

Create an new array with copies of the first 'size' vectors of a given array of vectors. The new array contains new vectors containing the same data as the original vectors.

Parameters:

data - array of vectors

size - number of copied vectors of array

Returns:

new array with number of vectors equal to argument 'size'

See Also:

copyNew(PiVector []), copy(PiVector [], int, PiVector [], int, int)

copy

public static boolean copy(PiVector[] dataDest,
                           int destInd,
                           PiVector[] dataSrc,
                           int srcInd,
                           int size)

Copies some vectors of a given array of vectors into an existing destination array. All vectors in source and destination array must exist already.

   for (int i=0; i
 Destination array must be large enough, i.e. dataDest.length >= destInd+size.

Parameters:
dataDest - destination array of vectors
destInd - index of first destination vector in dataDest
dataSrc - source array of vectors
srcInd - index of first source vector in dataSrc used for copying
size - number of copied vectors of array
Returns:
true if destination array is large enough
See Also: 
copy(PiVector)

getSameSize

public static int getSameSize(PiVector[] vecArray,
                              int numUsed)

Check of all vectors in array of vector have same length.

Returns:

same length, or -1 if different or no entries.

min

public static final boolean min(PiVector min,
                                PiVector[] aVecArray,
                                int arrayLength)

Find the minimum of an array of vectors in each component. Vectors of array may have different length. Any comparision is between the resulting vector and a vector of the array is done for the common number of components.

Parameters:

min - computed minimum

aVecArray - array of vectors

arrayLength - number of used vectors of array

See Also:

max(PiVector, PiVector [], int)

max

public static final boolean max(PiVector max,
                                PiVector[] aVecArray,
                                int arrayLength)

Find the maximum of an array of vectors in each component. Vectors of array may have different length. Any comparision is between the resulting vector and a vector of the array is done for the common number of components.

Parameters:

max - computed maximum

aVecArray - array of vectors

arrayLength - number of used vectors of array

See Also:

min(PiVector, PiVector [], int)

setConstant

public static void setConstant(PiVector[] aVecArray,
                               int aValue)

Set all components of all vectors of an array to a constant.

setConstant

public static void setConstant(PiVector[] aVecArray,
                               int[] data)

Set all vectors of an array equal to a given vector. All vectors of argument array must have same length.

setConstant

public static void setConstant(PiVector[] aVecArray,
                               PiVector aVector)

Set all vectors of an array equal to a given vector. All vectors of argument array must have same length.

setConstant

public static void setConstant(PiVector v,
                               int aValue)

Set all entries to a constant value.

setConstant

public void setConstant(int aValue)

Set all entries to a constant value.

getSize

public int getSize()

Return size of vector, i.e. number of entries in data array.

setSize

public int setSize(int aSize)

Set dimension of vector, i.e. length of its data array. Existing data is copied into the new array.

Parameters:

new - number of components of vector

Returns:

new number of components of vector

getEntries

public int[] getEntries()

Return a copy of content of vector as array of integers.

getEntry

public int getEntry(int ind)

Get the component of a vector.

setEntry

public void setEntry(int ind,
                     int value)

Assign value to component of vector, and possibly enlarge vector if too small.

Parameters:

ind - index of component to modify

value - new value of component

getFirstEntry

public int getFirstEntry()

Get the first component of a vector.

Returns:

value of the first component.

setFirstEntry

public void setFirstEntry(int value)

Set the first component of a vector.

Parameters:

value - new value of first component

getLastEntry

public int getLastEntry()

Get the last component of a vector.

Returns:

value of the last component.

setLastEntry

public void setLastEntry(int value)

Set the last component of a vector.

Parameters:

value - new value of last component

addEntry

public int addEntry(int val)

Add another entry at the end of the vector and increment size of vector.

Parameters:

value - to be added

Returns:

index of new last entry.

set

public void set(PiVector x,
                int from,
                int len)

Assign 'len' values of array starting at 'from' to vector, and adjust length of vector if different from argument len.

set

public void set(int[] x,
                int from,
                int len)

Assign 'len' values of array starting at 'from' to vector, and adjust length of vector if different from argument len.

set

public void set(int[] x,
                int len)

Assign first values of array to vector, and adjust length of vector if different from argument len.

set

public void set(int[] x)

Assign values of vector, and adjust length of vector if different from length of array.

set

public void set(int x)

Assign value to vector, and set size of vector to 1.

set

public void set(int x,
                int y)

Assign value to vector, and set size of vector to 2.

set

public void set(int x,
                int y,
                int z)

Assign value to vector, and set size of vector to 3.

set

public void set(int x,
                int y,
                int z,
                int w)

Assign value to vector, and set size of vector to 4.

getIndexOf

public int getIndexOf(int aValue)

Find index of first occurrence of value 'aValue' in vector.

changeValue

public int changeValue(int usedSize,
                       int oldValue,
                       int newValue)

Change occurrence of value oldValue to newValue on first 'usedSize' positions difference to method changeValue(int, int): sometime we use vectors where only the first entries are used. The other entries are not used and initialized to zero. If by chance 'oldValue' is zero then these initialization would be spoiled, which is very error prone. return number of changed positions

changeValue

public int changeValue(int oldValue,
                       int newValue)

Change all occurrence of value oldValue to newValue COMPARE: changeValue(int, int, int) return number of changed positions

shift

public void shift(int num)

Shift components in cyclic order within the array. HACK: currently, only num==1 and num==-1 are allowed.

Parameters:

num - number of positions each component is shifted

See Also:

invert()

invert

public void invert(int usedSize)

Invert order of the first 'usedSize' entries, i.e. the first entry becomes the 'usedSize-1' entry.

See Also:

invert()

invert

public void invert()

Invert order of all entries, i.e. the first entry becomes the last entry.

See Also:

invert(int)

add

public void add(int val)

Add argument to each component of vector.

add

public void add(PiVector m)

Sum with argument vector this = this+m.

add

public void add(PiVector m1,
                PiVector m2)

Sum of argument vectors this = m1+m2.

sub

public void sub(PiVector m)

Difference with argument vector this = this-m.

sub

public void sub(PiVector m1,
                PiVector m2)

subNew

public static PiVector subNew(PiVector m1,
                              PiVector m2)

Create a new vector as difference of argument vectors new = m1-m2.

copyNew

public static PiVector copyNew(PiVector v)

Create a new vector as clone of argument vector.

Parameters:

v - source vector to clone

copy

public boolean copy(int destInd,
                    PiVector dataSrc,
                    int srcInd,
                    int size)

Copy part of a vector into a vector, and adjust size of dest vector only it is too small.

See Also:

copy(PiVector)

copy

public void copy(PiVector v)

Copy a vector into a vector, and do not adjust size of dest vector. If destination vector is empty then allocated space of size of source vector. If source and destination vectors have different size then use the mininum of both sizes. If destination vector is bigger than source then reset the additional entries in destination vector with 0.

Parameters:

v - source vector to copy

See Also:

copy(int,PiVector,int,int)

copyArray

public void copyArray(PiVector v)

Copy data array of source vector into this vector, and do not adjust size of dest vector. In contrast to #copy(PdVector) this method does not invoke the copy method of the superclass. If destination vector is empty then allocated space of size of source vector. If source and destination vectors have different size then use the mininum of both sizes for copying. If destination vector is bigger than source then reset the additional entries in destination vector with 0.

Parameters:

v - source vector to copy

See Also:

copy(PiVector)

copy

public void copy(int[] anArray,
                 int aSize)

Copy a integer array into a vector, and do not adjust size of dest vector. If destination vector is empty then allocated space of size of source array. If source and destination vectors have different size then use the mininum of both sizes. If destination vector is bigger than source then reset the additional entries in destination vector with 0.

See Also:

copy(int, PiVector, int, int)

multScalar

public void multScalar(int scalar)

Multiply vector with scalar this = scalar*this.

multScalar

public void multScalar(PiVector v,
                       int scalar)

Multiply argument vector with scalar this = scalar*v.

leftMultMatrix

public void leftMultMatrix(PdMatrix m)

Multiply vector with matrix this = m*this. Matrix must be square and of same size than vector. Method does not change size of 'this'!

leftMultMatrix

public void leftMultMatrix(PdMatrix m,
                           PiVector v)

Multiply vector with matrix this = m*v. Matrix need not be square. Method modifies size of vector to number of row of matrix.

rightMultMatrix

public void rightMultMatrix(PdMatrix m)

Multiply vector with matrix this = this*m. Matrix must be square and of same size than vector. Method does not change size of 'this'!

rightMultMatrix

public void rightMultMatrix(PiVector v,
                            PdMatrix m)

Multiply vector with matrix this = v*m. Matrix need not be square. Method modifies size of vector to number of columns of matrix.

dot

public static int dot(PiVector v,
                      PiVector w)

Scalar product of two vectors.

dot

public int dot(PiVector v)

Compute scalar product with argument vector.

sqrLength

public int sqrLength()

Get square of euclidean length of vector.

length

public int length()

Get euclidean length of vector.

normalize

public boolean normalize()

Normalize vector to unit length.

normalize

public void normalize(PiVector v)

Set vector to normalized argument vector.

setLength

public void setLength(int aLength)

Set euclidean length of vector.

blendNew

public static PiVector blendNew(int a,
                                PiVector v,
                                int b,
                                PiVector w)

Create a new vector this = a*v + b*w.

See Also:

blend(int, PiVector, int, PiVector), blendBase(PiVector, int, PiVector)

blend

public void blend(int a,
                  PiVector v,
                  int b,
                  PiVector w)

Interpolate between two vectors with given weights. Uses this = v*a + w*b. If result vector 'this' is empty then its size is set to length of vector v, otherwise interpolation is done up to length of result vector.

Parameters:

v - first vector

a - weight of vector v

w - second vector

b - weight of vector w

See Also:

blendBase(PiVector, int, PiVector), blendNew(int, PiVector, int, PiVector)

blendBase

public void blendBase(PiVector v,
                      int b,
                      PiVector w)

Interpolate between two vectors with given weights. Uses this = v + w*b. If result vector 'this' is empty then its size is set to length of vector v, otherwise interpolation is done up to length of result vector.

Parameters:

v - first vector

w - second vector

b - weight of vector w

See Also:

blend(int, PiVector, int, PiVector), blendNew(int, PiVector, int, PiVector)

dist

public int dist(PiVector v)

Euclidean distance dist = |this-v|.

sqrDist

public int sqrDist(PiVector v)

Square of euclidean distance sqrDist = |this-v|^2.

max

public int max()

Find maximum value in vector.

See Also:

min(), indexOfMax(), indexOfAbsMax()

maxAbs

public double maxAbs()

Find maximal absolute value of component in vector.

Returns:

absolute value of maximal absolute component

See Also:

min(), indexOfMax(), indexOfAbsMax()

min

public int min()

Find minimal value of component in vector.

Returns:

value of minimal component

See Also:

max(), indexOfMin(), indexOfAbsMin()

indexOfAbsMax

public int indexOfAbsMax()

Find component in vector with maximal absolute value.

Returns:

index of maximal absolute component

See Also:

max(), indexOfMax()

indexOfAbsMin

public int indexOfAbsMin()

Find component in vector with minimal absolute value.

Returns:

index of minimal absolute component

See Also:

min(), indexOfMin()

indexOfMax

public int indexOfMax()

Find component in vector with maximal value.

Returns:

index of maximal component

See Also:

indexOfAbsMax()

indexOfMin

public int indexOfMin()

Find component in vector with minimal value.

Returns:

index of minimal component

See Also:

indexOfAbsMin()

hasUniqueEntries

public boolean hasUniqueEntries()

Check, whether all entrys of this vector are different.

sort

public void sort(PiVector vecOut)

Fill OutVector with sorted entries of this PiVector.

sort

public void sort()

Sort entries of this PiVector by size.

equals

public boolean equals(int[] list)

Compare vector with list of integers and return false if different array lengths or a different entry. Determines whether a list of integers is equal to data of this vector. The result is true if both arrays have same length and equal components. Result is also true if argument vector is null and this vector has no entries.

Parameters:

list - the list of integers to compare with

Returns:

true if the objects are the same; false otherwise.

equals

public boolean equals(PiVector vec)

Determines whether another vector is equal to this vector. The result is true if both vectors have same length and equal components. Result is also true if argument vector is null and this vector has no entries.

Parameters:

vec - the vector to compare with

Returns:

true if the objects are the same; false otherwise.

toString

public java.lang.String toString()

Create a multi-line string representation with detailed information about all instance variables.

Overrides:

toString in class P_Vector

See Also:

toShortString()

toShortString

public java.lang.String toShortString()

Create a single-line string representation of the vector components and attributes.

See Also:

toString()