kome::core::Vector Class Reference

vector class More...

#include <Vector.h>

Public Member Functions
	Vector (const unsigned int dim)
	constructor More...
	Vector (const Vector &v)
	copy constructor More...
virtual	~Vector ()
	destructor
unsigned int	getDimention ()
	gets the dimention size of vector More...
double	norm ()
	gets the norm of the vector More...
double	dot (const Vector &v)
	gets dot production More...
Vector	cross (const Vector &v)
	get cross production More...
Vector	operator= (const Vector &v)
	copy vector More...
double &	operator() (const unsigned int index)
	gets reference of value of specified element More...
Vector &	operator+= (const Vector &v)
	vector addition More...
Vector &	operator-= (const Vector &v)
	vector subtraction More...
Vector &	operator*= (const double k)
	scalar multiplication More...
Vector &	operator/= (const double k)
	scalar division More...
Vector	operator+ (const Vector &v)
	vector addition More...
Vector	operator- (const Vector &v)
	vector subtraction More...
Vector	operator* (const double k)
	scalar multiplication More...
Vector	operator/ (const double k)
	scalar division More...

Protected Attributes
const unsigned int	m_dim
double *const	m_array

Detailed Description

vector class

Definition at line 22 of file Vector.h.

Constructor & Destructor Documentation

kome::core::Vector::Vector

(

const unsigned int

dim

)

constructor

Parameters

[in]

dim

dimention size

Definition at line 30 of file Vector.cpp.

        : m_dim( dim ), m_array( ( dim == 0 ) ? NULL : new double[ dim ] ) {
    if( m_array != NULL ) {
        fillzero( m_array, sizeof( double ) * m_dim );
    }
}

Here is the call graph for this function:

kome::core::Vector::Vector

(

const Vector &

v

)

copy constructor

Parameters

[in]

v

Vector object to be copied

Definition at line 38 of file Vector.cpp.

        : m_dim( v.m_dim ), m_array( ( v.m_array == NULL ) ? NULL : new double[ v.m_dim ] ) {
    if( m_array != NULL ) {
        memcpy( m_array, v.m_array, sizeof( double ) * v.m_dim );
    }
}

Member Function Documentation

Vector kome::core::Vector::cross

(

const Vector &

v

)

get cross production

Parameters

[in]

v

vector to product

Returns

cross production vector

Definition at line 84 of file Vector.cpp.

                                      {
    if( m_dim != 3 || v.m_dim != 3 ) {
        throw FMT( "Vector size is illegal." );
    }

    Vector tmp( 3 );
    tmp( 0 ) = m_array[ 1 ] * v.m_array[ 2 ] - m_array[ 2 ] * v.m_array[ 1 ];
    tmp( 1 ) = m_array[ 2 ] * v.m_array[ 0 ] - m_array[ 0 ] * v.m_array[ 2 ];
    tmp( 2 ) = m_array[ 0 ] * v.m_array[ 1 ] - m_array[ 1 ] * v.m_array[ 0 ];

    return tmp;
}

double kome::core::Vector::dot

(

const Vector &

v

)

gets dot production

Parameters

[in]

v

vector to product

Returns

dot production

Definition at line 70 of file Vector.cpp.

                                    {
    if( v.m_dim != m_dim ) {
        throw FMT( "Vector size is illegal." );
    }

    double dp = 0.0;
    for( unsigned int i = 0; i < m_dim; i++ ) {
        dp += m_array[ i ] * v.m_array[ i ];
    }

    return dp;
}

unsigned int kome::core::Vector::getDimention

(

)

gets the dimention size of vector

Returns

the dimention size of vector

Definition at line 53 of file Vector.cpp.

                                  {
    return m_dim;
}

double kome::core::Vector::norm

(

)

gets the norm of the vector

Returns

norm

Definition at line 58 of file Vector.cpp.

                    {
    double n = 0.0;
    for( unsigned int i = 0; i < m_dim; i++ ) {
        n += ( m_array[ i ] * m_array[ i ] );
    }

    n = sqrt( n );

    return n;
}

double & kome::core::Vector::operator()

(

const unsigned int

index

)

gets reference of value of specified element

Parameters

[in]

index

index

Returns

reference of value of specified element

Definition at line 111 of file Vector.cpp.

                                                     {
    // check parameter
    if( index >= m_dim ) {
        throw FMT( "The specified element does not exist. [dimension=%d, index=%d]", m_dim, index );
    }

    return m_array[ index ];
}

Vector kome::core::Vector::operator*

(

const double

k

)

scalar multiplication

Parameters

[in]

k

real number to multiple

Returns

multiplication vector

Definition at line 187 of file Vector.cpp.

                                         {
    Vector tmp = *this;
    tmp *= k;

    return tmp;
}

Vector & kome::core::Vector::operator*=

(

const double

k

)

scalar multiplication

Parameters

[in]

k

real number to multiple

Returns

multiplication vector

Definition at line 151 of file Vector.cpp.

                                           {
    // multiplication
    for( unsigned int i = 0; i < m_dim; i++ ) {
        m_array[ i ] *= k;
    }

    return *this;
}

Vector kome::core::Vector::operator+

(

const Vector &

v

)

vector addition

Parameters

[in]

v

vector to add

Returns

addition vector

Definition at line 171 of file Vector.cpp.

                                          {
    Vector tmp = *this;
    tmp += v;

    return tmp;
}

Vector & kome::core::Vector::operator+=

(

const Vector &

v

)

vector addition

Parameters

[in]

v

vector to add

Returns

addition vector

Definition at line 121 of file Vector.cpp.

                                            {
    // check size
    if( v.m_dim != m_dim ) {
        throw FMT( "Vector size is illegal." );
    }

    // addition
    for( unsigned int i = 0; i < m_dim; i++ ) {
        m_array[ i ] += v.m_array[ i ];
    }

    return *this;
}

Vector kome::core::Vector::operator-

(

const Vector &

v

)

vector subtraction

Parameters

[in]

v

vector to subtract

Returns

subtraction vector

Definition at line 179 of file Vector.cpp.

                                          {
    Vector tmp = *this;
    tmp -= v;

    return tmp;
}

Vector & kome::core::Vector::operator-=

(

const Vector &

v

)

vector subtraction

Parameters

[in]

v

vector to subtract

Returns

subtraction vector

Definition at line 136 of file Vector.cpp.

                                            {
    // check size
    if( v.m_dim != m_dim ) {
        throw FMT( "Vector size is illegal." );
    }

    // addition
    for( unsigned int i = 0; i < m_dim; i++ ) {
        m_array[ i ] -= v.m_array[ i ];
    }

    return *this;
}

Vector kome::core::Vector::operator/

(

const double

k

)

scalar division

Parameters

[in]

k

real number to divide

Returns

division vector

Definition at line 195 of file Vector.cpp.

                                         {
    Vector tmp = *this;
    tmp /= k;

    return tmp;
}

Vector & kome::core::Vector::operator/=

(

const double

k

)

scalar division

Returns

k real number to divide

division vector

Definition at line 161 of file Vector.cpp.

                                           {
    // division
    for( unsigned int i = 0; i < m_dim; i++ ) {
        m_array[ i ] /= k;
    }

    return *this;
}

Vector kome::core::Vector::operator=

(

const Vector &

v

)

copy vector

Parameters

[in]

v

source vector to be copied

Returns

copied vector

Definition at line 98 of file Vector.cpp.

                                          {
    if( v.m_dim != m_dim ) {
        throw FMT( "Vector size is illegal." );
    }

    if( m_array != NULL ) {
        memcpy( m_array, v.m_array, sizeof( double ) * m_dim );
    }

    return *this;
}

Member Data Documentation

double* const kome::core::Vector::m_array

protected

value array

Definition at line 48 of file Vector.h.

const unsigned int kome::core::Vector::m_dim

protected

dimention size

Definition at line 46 of file Vector.h.

---

The documentation for this class was generated from the following files:

• CoreToolkits/Vector.h
• CoreToolkits/Vector.cpp