VectoriBase (Artisynth API documentation)

java.lang.Object
- maspack.matrix.VectoriBase

All Implemented Interfaces:

java.lang.Cloneable, Vectori, Clonable

Direct Known Subclasses:

Vector2i, Vector3i, VectorNi
```
public abstract class VectoriBase
extends java.lang.Object
implements Vectori
```
Base implementation of Vectori.

Constructor Summary

Constructors
Constructor and Description

VectoriBase()

Constructors
Constructor and Description
`VectoriBase()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`VectoriBase`	`clone()`
`boolean`	`equals(Vectori v1)` Returns true if the elements of this vector exactly equal those of vector `v1`.
`abstract int`	`get(int i)` Gets a single element of this vector.
`void`	`get(int[] values)` Copies the elements of this vector into an array of doubles.
`static java.lang.String`	`getDefaultFormat()` Returns the default format string used in `toString`.
`int`	`infinityNorm()` Returns the infinity norm of this vector.
`boolean`	`isFixedSize()` Returns true if this vector is of fixed size.
`int`	`maxElement()` Returns the maximum element value.
`int`	`minElement()` Returns the minimum element value.
`double`	`norm()` Returns the 2 norm of this vector.
`double`	`normSquared()` Returns the square of the 2 norm of this vector.
`int`	`oneNorm()` Returns the 1 norm of this vector.
`void`	`scan(ReaderTokenizer rtok)` Sets the contents of this vector to values read from a ReaderTokenizer.
`void`	`set(int[] values)` Sets the elements of this vector from an array of doubles.
`abstract void`	`set(int i, int value)` Sets a single element of this vector.
`void`	`set(Vectori v)` Sets the values of this vector to those of another vector.
`static void`	`setDefaultFormat(java.lang.String fmtStr)` Sets the default format string used in `toString`.
`void`	`setSize(int n)` Sets the size of this vector.
`abstract int`	`size()` Returns the number of elements in this vector.
`java.lang.String`	`toString()` Returns a String representation of this vector, using the default format returned by `getDefaultFormat`.
`java.lang.String`	`toString(NumberFormat fmt)` Returns a String representation of this vector, in which each element is formatted using a C `printf` style format (for integers) as decribed by the parameter `NumberFormat`.
`java.lang.String`	`toString(java.lang.String fmtStr)` Returns a String representation of this vector, in which each element is formatted using a C `printf` style format string (for integers).
`void`	`write(java.io.PrintWriter pw, NumberFormat fmt)` Writes the contents of this vector to a PrintWriter.
`void`	`write(java.io.PrintWriter pw, NumberFormat fmt, boolean withBrackets)` Writes the contents of this vector to a PrintWriter.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VectoriBase
```
public VectoriBase()
```
- Method Detail
  - setDefaultFormat
```
public static void setDefaultFormat(java.lang.String fmtStr)
```
    Sets the default format string used in toString. For a description of the format string syntax, see NumberFormat.
    
    Parameters:
    
    fmtStr - new format string
    
    Throws:
    
    java.lang.IllegalArgumentException - if the format string is invalid
    
    See Also:
    
    getDefaultFormat()
  - getDefaultFormat
```
public static java.lang.String getDefaultFormat()
```
    Returns the default format string used in toString. If unset, this string is "%d". For a description of the format string syntax, see NumberFormat.
    
    Returns:
    
    Default format string
  - size
```
public abstract int size()
```
    Returns the number of elements in this vector.
    
    Specified by:
    
    size in interface Vectori
    
    Returns:
    
    number of elements
  - get
```
public abstract int get(int i)
```
    Gets a single element of this vector.
    
    Specified by:
    
    get in interface Vectori
    
    Parameters:
    
    i - element index
    
    Returns:
    
    element value
  - get
```
public void get(int[] values)
```
    Copies the elements of this vector into an array of doubles. The array length must be >= the size of the vector.
    
    Specified by:
    
    get in interface Vectori
    
    Parameters:
    
    values - array into which values are copied
  - set
```
public abstract void set(int i,
                         int value)
```
    Sets a single element of this vector.
    
    Specified by:
    
    set in interface Vectori
    
    Parameters:
    
    i - element index
    
    value - element value
  - set
```
public void set(int[] values)
```
    Sets the elements of this vector from an array of doubles. If the vector has a fixed size, then the array must have a length >= the current vector size. Otherwise, the vector is resized to the array length.
    
    Specified by:
    
    set in interface Vectori
    
    Parameters:
    
    values - array from which values are copied
  - set
```
public void set(Vectori v)
```
    Sets the values of this vector to those of another vector.
    
    Specified by:
    
    set in interface Vectori
    
    Parameters:
    
    v - vector from which values are copied
  - isFixedSize
```
public boolean isFixedSize()
```
    Returns true if this vector is of fixed size. If this vector is not of fixed size, then it can be resized dynamically, either explicitly using setSize, or implicitly when used as a result for various vector operations.
    
    Specified by:
    
    isFixedSize in interface Vectori
    
    Returns:
    
    true if this vector is of fixed size
    
    See Also:
    
    Vectori.setSize(int)
  - setSize
```
public void setSize(int n)
```
    Sets the size of this vector. This operation is only supported if isFixedSize returns false.
    
    Specified by:
    
    setSize in interface Vectori
    
    Parameters:
    
    n - new size
    
    See Also:
    
    Vectori.isFixedSize()
  - norm
```
public double norm()
```
    Returns the 2 norm of this vector. This is the square root of the sum of the squares of the elements.
    
    Specified by:
    
    norm in interface Vectori
    
    Returns:
    
    vector 2 norm
  - normSquared
```
public double normSquared()
```
    Returns the square of the 2 norm of this vector. This is the sum of the squares of the elements.
    
    Specified by:
    
    normSquared in interface Vectori
    
    Returns:
    
    square of the 2 norm
  - oneNorm
```
public int oneNorm()
```
    Returns the 1 norm of this vector. This is the sum of the absolute values of the elements.
    
    Specified by:
    
    oneNorm in interface Vectori
    
    Returns:
    
    vector 1 norm
  - infinityNorm
```
public int infinityNorm()
```
    Returns the infinity norm of this vector. This is the maximum absolute value over all elements.
    
    Specified by:
    
    infinityNorm in interface Vectori
    
    Returns:
    
    vector infinity norm
  - maxElement
```
public int maxElement()
```
    Returns the maximum element value.
    
    Specified by:
    
    maxElement in interface Vectori
    
    Returns:
    
    maximal element
  - minElement
```
public int minElement()
```
    Returns the minimum element value.
    
    Specified by:
    
    minElement in interface Vectori
    
    Returns:
    
    minimal element
  - equals
```
public boolean equals(Vectori v1)
```
    Returns true if the elements of this vector exactly equal those of vector v1. If the vectors have different sizes, false is returned.
    
    Specified by:
    
    equals in interface Vectori
    
    Parameters:
    
    v1 - vector to compare with
    
    Returns:
    
    false if the vectors are not equal or have different sizes
  - write
```
public void write(java.io.PrintWriter pw,
                  NumberFormat fmt)
           throws java.io.IOException
```
    Writes the contents of this vector to a PrintWriter. Element values are separated by spaces, and each element is formatted using a C printf style (for integers) as decribed by the parameter NumberFormat.
    
    Specified by:
    
    write in interface Vectori
    
    Parameters:
    
    pw - PrintWriter to write this vector to
    
    fmt - numeric format
    
    Throws:
    
    java.io.IOException
  - write
```
public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  boolean withBrackets)
           throws java.io.IOException
```
    Writes the contents of this vector to a PrintWriter. Element values are separated by spaces, and optionally surrounded by square brackets [ ] if withBrackets is set true. Each element is formatted using a C printf style (for integers) as decribed by the parameter NumberFormat.
    
    Specified by:
    
    write in interface Vectori
    
    Parameters:
    
    pw - PrintWriter to write this vector to
    
    fmt - numeric format
    
    withBrackets - if true, causes the output to be surrounded by square brackets.
    
    Throws:
    
    java.io.IOException
  - scan
```
public void scan(ReaderTokenizer rtok)
          throws java.io.IOException
```
    Sets the contents of this vector to values read from a ReaderTokenizer. The input should consist of a sequence of numbers, separated by white space and optionally surrounded by square brackets [ ].
    If the input is not surrounded by square brackets, then the number of values should equal the current size of this vector.
    If the input is surrounded by square brackets, then all values up to the closing bracket are read, and the resulting number of values should either equal the current size of this vector, or this vector should be resizeable to fit the input. For example,
```
 [ 1 4 5 3 ]
 
```
    defines a vector of size 4.
    Specified by:
    
    scan in interface Vectori
    
    Parameters:
    
    rtok - Tokenizer from which vector values are read. Number parsing should be enabled.
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this vector, using the default format returned by getDefaultFormat.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation of this vector
    
    See Also:
    
    toString(String)
  - toString
```
public java.lang.String toString(java.lang.String fmtStr)
```
    Returns a String representation of this vector, in which each element is formatted using a C printf style format string (for integers). The exact format for this string is described in the documentation for NumberFormat.set(String){NumberFormat.set(String)}. Note that when called numerous times, toString(NumberFormat) will be more efficient because the NumberFormat will not need to be recreated each time from a specification string.
    
    Specified by:
    
    toString in interface Vectori
    
    Parameters:
    
    fmtStr - printf style format string
    
    Returns:
    
    String representation of this vector
    
    See Also:
    
    NumberFormat
  - toString
```
public java.lang.String toString(NumberFormat fmt)
```
    Returns a String representation of this vector, in which each element is formatted using a C printf style format (for integers) as decribed by the parameter NumberFormat.
    
    Specified by:
    
    toString in interface Vectori
    
    Parameters:
    
    fmt - numeric format
    
    Returns:
    
    String representation of this vector
  - clone
```
public VectoriBase clone()
```
    Specified by:
    
    clone in interface Clonable
    
    Overrides:
    
    clone in class java.lang.Object

Class VectoriBase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VectoriBase

Method Detail

setDefaultFormat

getDefaultFormat

size

get

get

set

set

set

isFixedSize

setSize

norm

normSquared

oneNorm

infinityNorm

maxElement

minElement

equals

write

write

scan

toString

toString

toString

clone