org.drip.function.definition

Class SizedVector

java.lang.Object

org.drip.function.definition.SizedVector

public class SizedVector
extends java.lang.Object

SizedVector holds the R^d Unit Direction Vector along with its Magnitude.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
SizedVector(UnitVector uv, double dblMagnitude) SizedVector Constructor

Method Summary

Modifier and Type	Method and Description
UnitVector	direction() Retrieve the Unit Direction Vector
double	magnitude() Retrieve the Vector Magnitude
static SizedVector	Standard(double[] adbl) Construct an Instance of the Sized Vector from the Input Array

Methods inherited from class java.lang.Object

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

Constructor Detail

SizedVector

public SizedVector(UnitVector uv,
                   double dblMagnitude)
            throws java.lang.Exception

SizedVector Constructor

Parameters:

uv - The Unit Vector

dblMagnitude - Magnitude of the Vector

Throws:

java.lang.Exception - Thriwn if the Inputs are Invalid

Method Detail

Standard

public static final SizedVector Standard(double[] adbl)

Construct an Instance of the Sized Vector from the Input Array

Parameters:

adbl - The Input Double Array

Returns:

The Sized Vector Instance

direction

public UnitVector direction()

Retrieve the Unit Direction Vector

Returns:

The Unit Vector Direction Instance

magnitude

public double magnitude()

Retrieve the Vector Magnitude

Returns:

The Vector Magnitude