FVector (LBJava 1.2.22 API)

java.lang.Object
- edu.illinois.cs.cogcomp.lbjava.util.FVector

All Implemented Interfaces:

Serializable, Cloneable
```
public class FVector
extends Object
implements Cloneable, Serializable
```
This class implements an expandable array of features that should be faster than java's Vector.

Author:

Nick Rizzolo

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`defaultCapacity` The default capacity of a vector upon first construction.
`protected int`	`size` The number of elements in the vector.
`protected Feature[]`	`vector` The elements of the vector.

Constructor Summary

Constructors
Constructor and Description
`FVector()` Constructs a new vector with capacity equal to `defaultCapacity`.
`FVector(Feature[] v)` Constructs a new vector using the specified array as a starting point.
`FVector(FVector v)` Constructs a copy of a vector starting with capacity equal to that vector's size.
`FVector(int c)` Constructs a new vector with the specified capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Feature v)` Adds the specified value on to the end of the vector, expanding its capacity as necessary.
`void`	`addAll(FVector v)` Adds all the values in the given vector to the end of this vector, expanding its capacity as necessary.
`protected void`	`boundsCheck(int i)` Throws an exception when the specified index is negative.
`Object`	`clone()` Returns a shallow clone of this vector; the vector itself is cloned, but the element objects aren't.
`void`	`consolidate()` After calling this method, the new size and capacity of this vector will be equal to the number of non-`null` elements; all such elements will be retained in the same relative order.
`boolean`	`equals(Object o)` Two `FVector`s are considered equal if they contain equivalent elements and have the same size.
`protected void`	`expandFor(int index, Feature d)` Makes sure the capacity and size of the vector can accomodate the given index.
`Feature`	`get(int i)` Retrieves the value stored at the specified index of the vector, or `null` if the vector isn't long enough.
`Feature`	`get(int i, Feature d)` Retrieves the value stored at the specified index of the vector or `d` if the vector isn't long enough.
`int`	`hashCode()` A hash code based on the hash code of `vector`.
`void`	`read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)` Reads the binary representation of a vector from the specified stream, overwriting the data in this object.
`Feature`	`remove(int i)` Removes the element at the specified index of the vector.
`Feature`	`set(int i, Feature v)` Sets the value at the specified index to the given value.
`Feature`	`set(int i, Feature v, Feature d)` Sets the value at the specified index to the given value.
`int`	`size()` Returns the value of `size`.
`void`	`sort()` Sorts this vector in increasing order.
`Feature[]`	`toArray()` Returns a new array of features containing the same data as this vector.
`String`	`toString()` Returns a text representation of this vector.
`void`	`write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out)` Writes a binary representation of this vector to the given stream.

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

- Field Detail
  - defaultCapacity
```
protected static final int defaultCapacity
```
    The default capacity of a vector upon first construction.
    
    See Also:
    
    Constant Field Values
  - vector
```
protected Feature[] vector
```
    The elements of the vector.
  - size
```
protected int size
```
    The number of elements in the vector.
- Constructor Detail
  - FVector
```
public FVector()
```
    Constructs a new vector with capacity equal to defaultCapacity.
  - FVector
```
public FVector(int c)
```
    Constructs a new vector with the specified capacity.
    
    Parameters:
    
    c - The initial capacity for the new vector.
  - FVector
```
public FVector(Feature[] v)
```
    Constructs a new vector using the specified array as a starting point.
    
    Parameters:
    
    v - The initial array.
  - FVector
```
public FVector(FVector v)
```
    Constructs a copy of a vector starting with capacity equal to that vector's size.
    
    Parameters:
    
    v - The vector to copy.
- Method Detail
  - boundsCheck
```
protected void boundsCheck(int i)
```
    Throws an exception when the specified index is negative.
    
    Parameters:
    
    i - The index.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - When i < 0.
  - get
```
public Feature get(int i)
```
    Retrieves the value stored at the specified index of the vector, or null if the vector isn't long enough.
    
    Parameters:
    
    i - The index of the value to retrieve.
    
    Returns:
    
    The retrieved value.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - When i < 0.
  - get
```
public Feature get(int i,
                   Feature d)
```
    Retrieves the value stored at the specified index of the vector or d if the vector isn't long enough.
    
    Parameters:
    
    i - The index of the value to retrieve.
    
    d - The default value.
    
    Returns:
    
    The retrieved value.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - When i < 0.
  - set
```
public Feature set(int i,
                   Feature v)
```
    Sets the value at the specified index to the given value.
    
    Parameters:
    
    i - The index of the value to set.
    
    v - The new value at that index.
    
    Returns:
    
    The value that used to be at index i.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - When i < 0.
  - set
```
public Feature set(int i,
                   Feature v,
                   Feature d)
```
    Sets the value at the specified index to the given value. If the given index is greater than the vector's current size, the vector will expand to accomodate it.
    
    Parameters:
    
    i - The index of the value to set.
    
    v - The new value at that index.
    
    d - The default value for other new indexes that might get created.
    
    Returns:
    
    The value that used to be at index i.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - When i < 0.
  - add
```
public void add(Feature v)
```
    Adds the specified value on to the end of the vector, expanding its capacity as necessary.
    
    Parameters:
    
    v - The new value to appear last in the vector.
  - addAll
```
public void addAll(FVector v)
```
    Adds all the values in the given vector to the end of this vector, expanding its capacity as necessary.
    
    Parameters:
    
    v - The new vector of values to appear at the end of this vector.
  - remove
```
public Feature remove(int i)
```
    Removes the element at the specified index of the vector.
    
    Parameters:
    
    i - The index of the element to remove.
    
    Returns:
    
    The removed element.
  - size
```
public int size()
```
    Returns the value of size.
  - sort
```
public void sort()
```
    Sorts this vector in increasing order.
  - consolidate
```
public void consolidate()
```
    After calling this method, the new size and capacity of this vector will be equal to the number of non-null elements; all such elements will be retained in the same relative order.
  - expandFor
```
protected void expandFor(int index,
                         Feature d)
```
    Makes sure the capacity and size of the vector can accomodate the given index. The capacity of the vector is simply doubled until it can accomodate its size.
    
    Parameters:
    
    index - The index where a new value will be stored.
    
    d - The default value for other new indexes that might get created.
  - toArray
```
public Feature[] toArray()
```
    Returns a new array of features containing the same data as this vector.
  - equals
```
public boolean equals(Object o)
```
    Two FVectors are considered equal if they contain equivalent elements and have the same size.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    A hash code based on the hash code of vector.
    
    Overrides:
    
    hashCode in class Object
  - write
```
public void write(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessOutputStream out)
```
    Writes a binary representation of this vector to the given stream.
    
    Parameters:
    
    out - The output stream.
  - read
```
public void read(edu.illinois.cs.cogcomp.core.datastructures.vectors.ExceptionlessInputStream in)
```
    Reads the binary representation of a vector from the specified stream, overwriting the data in this object.
    
    Parameters:
    
    in - The input stream.
  - clone
```
public Object clone()
```
    Returns a shallow clone of this vector; the vector itself is cloned, but the element objects aren't.
    
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Returns a text representation of this vector.
    
    Overrides:
    
    toString in class Object

Class FVector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultCapacity

vector

size

Constructor Detail

FVector

FVector

FVector

FVector

Method Detail

boundsCheck

get

get

set

set

add

addAll

remove

size

sort

consolidate

expandFor

toArray

equals

hashCode

write

read

clone

toString