org.grouplens.lenskit.vectors

Class ImmutableVec

java.lang.Object

org.grouplens.lenskit.vectors.Vec

org.grouplens.lenskit.vectors.ImmutableVec

All Implemented Interfaces:

Serializable

@Immutable
public final class ImmutableVec
extends Vec

Immutable Vec. This vector cannot be modified (by anyone) and is thread-safe. You can create one using create(double[]) or immutable().

Since:

1.3

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
static ImmutableVec	create(double[] data) Create a new vector from data in an array.
ImmutableVec	immutable() Get an immutable vector with this vector's contents.
double	norm() Get the L2 (Euclidean) norm of this vector.
double	sum() Get the sum of this vector.

Methods inherited from class org.grouplens.lenskit.vectors.Vec

dot, equals, get, hashCode, mean, mutableCopy, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ImmutableVec create(double[] data)

Create a new vector from data in an array. The array is copied for safety.

Parameters:

data - The data array.

Returns:

A vector containing the data in data.

immutable

public ImmutableVec immutable()

Description copied from class: Vec

Get an immutable vector with this vector's contents. If the vector is already immutable, it is not changed.

Overrides:

immutable in class Vec

Returns:

The immutable vector.

sum

public double sum()

Description copied from class: Vec

Get the sum of this vector.

Overrides:

sum in class Vec

Returns:

The sum of the elements of the vector.

norm

public double norm()

Description copied from class: Vec

Get the L2 (Euclidean) norm of this vector.

Overrides:

norm in class Vec

Returns:

The Euclidean length of the vector.