Detailed Description

template<class T>
class shogun::SGVector< T >

shogun vector

Definition at line 28 of file base/Parameter.h.

Inheritance diagram for SGVector< T >:

Public Types
typedef Eigen::Matrix< T,-1, 1, 0,-1, 1 >	EigenVectorXt

typedef Eigen::Matrix< T, 1,-1, 0x1, 1,-1 >	EigenRowVectorXt

typedef Eigen::Map< EigenVectorXt, 0, Eigen::Stride< 0, 0 > >	EigenVectorXtMap

typedef Eigen::Map< EigenRowVectorXt, 0, Eigen::Stride< 0, 0 > >	EigenRowVectorXtMap

typedef T	Scalar

Public Member Functions
	SGVector ()

	SGVector (T *v, index_t len, bool ref_counting=true)

	SGVector (T *m, index_t len, index_t offset)

	SGVector (index_t len, bool ref_counting=true)

	SGVector (GPUMemoryBase< T > *vector, index_t len)

	SGVector (const SGVector &orig)

bool	on_gpu () const

	SGVector (EigenVectorXt &vec)

	SGVector (EigenRowVectorXt &vec)

	operator EigenVectorXtMap () const

	operator EigenRowVectorXtMap () const

void	set_const (T const_elem)

SGVector< T >	get ()

void	set (SGVector< T > orig)

virtual	~SGVector ()

int32_t	size () const

T *	data () const

SGVector< T > &	operator= (const SGVector< T > &)

	operator T* ()

void	zero ()

void	range_fill (T start=0)

void	random (T min_value, T max_value)

index_t	find_position_to_insert (T element)

SGVector< T >	clone () const

const T &	get_element (index_t index)

void	set_element (const T &el, index_t index)

void	resize_vector (int32_t n)

const T &	operator[] (uint64_t index) const

const T &	operator[] (int64_t index) const

const T &	operator[] (uint32_t index) const

const T &	operator[] (int32_t index) const

T &	operator[] (uint64_t index)

T &	operator[] (int64_t index)

T &	operator[] (uint32_t index)

T &	operator[] (int32_t index)

void	add (const SGVector< T > x)

void	add (const SGSparseVector< T > &x)

void	add (const T x)

SGVector< T >	operator+ (SGVector< T > x)

SGVector< T >	operator+= (SGVector< T > x)

SGVector< T >	operator+= (SGSparseVector< T > &x)

bool	equals (SGVector< T > &other)

T	product ()
	Return product(vec) More...

void	display_size () const

void	display_vector (const char name="vector", const char prefix="") const

SGVector< index_t >	find (T elem)

template<typename Predicate >
SGVector< index_t >	find_if (Predicate p)

void	scale (T alpha)
	Scale vector inplace. More...

void	load (CFile *loader)

void	save (CFile *saver)

SGVector< float64_t >	get_real ()

SGVector< float64_t >	get_imag ()

template<>
void	zero ()

template<>
index_t	find_position_to_insert (complex128_t element)

template<>
void	range_fill_vector (complex128_t *vec, int32_t len, complex128_t start)

template<>
void	display_vector (const bool vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const char vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const uint8_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const int8_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const uint16_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const int16_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const int32_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const uint32_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const int64_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const uint64_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const float32_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const float64_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const floatmax_t vector, int32_t n, const char name, const char *prefix)

template<>
void	display_vector (const complex128_t vector, int32_t n, const char name, const char *prefix)

template<>
void	vec1_plus_scalar_times_vec2 (float64_t vec1, float64_t scalar, const float64_t vec2, int32_t n)

template<>
void	vec1_plus_scalar_times_vec2 (float32_t vec1, float32_t scalar, const float32_t vec2, int32_t n)

template<>
void	random_vector (complex128_t *vec, int32_t len, complex128_t min_value, complex128_t max_value)

template<>
bool	twonorm (const bool *x, int32_t len)

template<>
char	twonorm (const char *x, int32_t len)

template<>
int8_t	twonorm (const int8_t *x, int32_t len)

template<>
uint8_t	twonorm (const uint8_t *x, int32_t len)

template<>
int16_t	twonorm (const int16_t *x, int32_t len)

template<>
uint16_t	twonorm (const uint16_t *x, int32_t len)

template<>
int32_t	twonorm (const int32_t *x, int32_t len)

template<>
uint32_t	twonorm (const uint32_t *x, int32_t len)

template<>
int64_t	twonorm (const int64_t *x, int32_t len)

template<>
uint64_t	twonorm (const uint64_t *x, int32_t len)

template<>
float32_t	twonorm (const float32_t *x, int32_t len)

template<>
float64_t	twonorm (const float64_t *v, int32_t n)

template<>
floatmax_t	twonorm (const floatmax_t *x, int32_t len)

template<>
complex128_t	twonorm (const complex128_t *x, int32_t len)

template<>
complex128_t	qsq (complex128_t *x, int32_t len, float64_t q)

template<>
complex128_t	qnorm (complex128_t *x, int32_t len, float64_t q)

template<>
float64_t	sum_abs (float64_t *vec, int32_t len)

template<>
float32_t	sum_abs (float32_t *vec, int32_t len)

template<>
int32_t	unique (complex128_t *output, int32_t size)

template<>
void	scale_vector (float64_t alpha, float64_t *vec, int32_t len)

template<>
void	scale_vector (float32_t alpha, float32_t *vec, int32_t len)

template<>
void	load (CFile *loader)

template<>
void	save (CFile *saver)

int32_t	ref_count ()

Static Public Member Functions
static T *	clone_vector (const T *vec, int32_t len)

static void	fill_vector (T *vec, int32_t len, T value)

static void	range_fill_vector (T *vec, int32_t len, T start=0)

static void	random_vector (T *vec, int32_t len, T min_value, T max_value)

static T	twonorm (const T *x, int32_t len)
	\|\| x \|\|_2 More...

static float64_t	onenorm (T *x, int32_t len)
	\|\| x \|\|_1 More...

static T	qsq (T *x, int32_t len, float64_t q)
	\|\| x \|\|_q^q More...

static T	qnorm (T *x, int32_t len, float64_t q)
	\|\| x \|\|_q More...

static void	vec1_plus_scalar_times_vec2 (T vec1, const T scalar, const T vec2, int32_t n)
	x=x+alpha*y More...

static void	vector_multiply (T target, const T v1, const T *v2, int32_t len)
	Compute vector multiplication. More...

static void	add (T target, T alpha, const T v1, T beta, const T *v2, int32_t len)
	target=alphavec1 + betavec2 More...

static void	add_scalar (T alpha, T *vec, int32_t len)
	Add scalar to vector inplace. More...

static void	scale_vector (T alpha, T *vec, int32_t len)
	Scale vector inplace. More...

static T	sum (T *vec, int32_t len)
	Return sum(vec) More...

static T	sum (SGVector< T > vec)
	Return sum(vec) More...

static T	product (T *vec, int32_t len)
	Return the product of the vectors elements. More...

static T	sum_abs (T *vec, int32_t len)
	return sum(abs(vec)) More...

static int32_t	unique (T *output, int32_t size)

static void	display_vector (const T vector, int32_t n, const char name="vector", const char *prefix="")
	Display vector (useful for debugging) More...

static void	display_vector (const SGVector< T >, const char name="vector", const char prefix="")
	Display vector (useful for debugging) More...

static SGMatrix< T >	convert_to_matrix (SGVector< T > vector, index_t nrows, index_t ncols, bool fortran_order)

static void	convert_to_matrix (T &matrix, index_t nrows, index_t ncols, const T vector, int32_t vlen, bool fortran_order)

Public Attributes
T *	vector

index_t	vlen

std::shared_ptr< GPUMemoryBase< T > >	gpu_ptr

Protected Member Functions
virtual void	copy_data (const SGReferencedData &orig)

virtual void	init_data ()

virtual void	free_data ()

void	copy_refcount (const SGReferencedData &orig)

int32_t	ref ()

int32_t	unref ()

Friends
class	LinalgBackendEigen

Member Typedef Documentation

◆ EigenRowVectorXt

typedef Eigen::Matrix<T,1,-1,0x1,1,-1> EigenRowVectorXt

Definition at line 48 of file SGVector.h.

◆ EigenRowVectorXtMap

typedef Eigen::Map<EigenRowVectorXt,0,Eigen::Stride<0,0> > EigenRowVectorXtMap

Definition at line 51 of file SGVector.h.

◆ EigenVectorXt

typedef Eigen::Matrix<T,-1,1,0,-1,1> EigenVectorXt

Definition at line 47 of file SGVector.h.

◆ EigenVectorXtMap

typedef Eigen::Map<EigenVectorXt,0,Eigen::Stride<0,0> > EigenVectorXtMap

Definition at line 50 of file SGVector.h.

◆ Scalar

typedef T Scalar

The scalar type of the vector

Definition at line 54 of file SGVector.h.

Constructor & Destructor Documentation

◆ SGVector() [1/8]

SGVector ( )

Default constructor

Definition at line 73 of file SGVector.cpp.

◆ SGVector() [2/8]

SGVector	(	T *	v,
		index_t	len,
		bool	ref_counting = `true`
	)

Constructor for setting params

Definition at line 79 of file SGVector.cpp.

◆ SGVector() [3/8]

SGVector	(	T *	m,
		index_t	len,
		index_t	offset
	)

Wraps a vector around an existing memory segment with an offset

Definition at line 86 of file SGVector.cpp.

◆ SGVector() [4/8]

SGVector	(	index_t	len,
		bool	ref_counting = `true`
	)

Constructor to create new vector in memory

Definition at line 93 of file SGVector.cpp.

◆ SGVector() [5/8]

SGVector	(	GPUMemoryBase< T > *	vector,
		index_t	len
	)

Construct SGVector from GPU memory.

Parameters

vector	GPUMemoryBase pointer
len	length of the data in vector

See also: GPUMemoryBase

Definition at line 101 of file SGVector.cpp.

◆ SGVector() [6/8]

SGVector ( const SGVector< T > & orig )

Copy constructor

Definition at line 109 of file SGVector.cpp.

◆ SGVector() [7/8]

SGVector ( EigenVectorXt & vec )

Wraps a matrix around the data of an Eigen3 column vector

Definition at line 140 of file SGVector.cpp.

◆ SGVector() [8/8]

SGVector ( EigenRowVectorXt & vec )

Wraps a matrix around the data of an Eigen3 row vector

Definition at line 147 of file SGVector.cpp.

◆ ~SGVector()

~SGVector ( )

virtual

Empty destructor

Definition at line 134 of file SGVector.cpp.

Member Function Documentation

◆ add() [1/4]

void add ( const SGVector< T > x )

Add vector to current vector

Parameters

x	add vector x to current vector

Definition at line 310 of file SGVector.cpp.

◆ add() [2/4]

void add ( const SGSparseVector< T > & x )

Add sparse vector to current vector

Parameters

x	add sparse vector x to current vector

Definition at line 330 of file SGVector.cpp.

◆ add() [3/4]

void add ( const T x )

Add scalar to current vector

Parameters

x	add vector x to current vector

Definition at line 321 of file SGVector.cpp.

◆ add() [4/4]

static void add	(	T *	target,
		T	alpha,
		const T *	v1,
		T	beta,
		const T *	v2,
		int32_t	len
	)

static

target=alpha*vec1 + beta*vec2

Definition at line 373 of file SGVector.h.

◆ add_scalar()

static void add_scalar	(	T	alpha,
		T *	vec,
		int32_t	len
	)

static

Add scalar to vector inplace.

Definition at line 382 of file SGVector.h.

◆ clone()

SGVector< T > clone ( ) const

Clone vector

Definition at line 247 of file SGVector.cpp.

◆ clone_vector()

T * clone_vector	(	const T *	vec,
		int32_t	len
	)

static

Clone vector

Definition at line 256 of file SGVector.cpp.

◆ convert_to_matrix() [1/2]

SGMatrix< T > convert_to_matrix	(	SGVector< T >	vector,
		index_t	nrows,
		index_t	ncols,
		bool	fortran_order
	)

static

Create SGMatrix from linear vector

Parameters

vector	source vector
nrows	number of rows
ncols	number of cols
fortran_order	order of stroing matrix in linear vector true - column-major order (FORTRAN, MATLAB, R) false - row-major order (C, Python)

Returns: matrix

Definition at line 945 of file SGVector.cpp.

◆ convert_to_matrix() [2/2]

void convert_to_matrix	(	T *&	matrix,
		index_t	nrows,
		index_t	ncols,
		const T *	vector,
		int32_t	vlen,
		bool	fortran_order
	)

static

Create matrix from linear vector

Parameters

matrix	destination memory
nrows	number of rows
ncols	number of cols
vector	source vector
vlen	lenght of source vector
fortran_order	order of stroing matrix in linear vector true - column-major order (FORTRAN, MATLAB, R) false - row-major order (C, Python)

Returns: matrix

Definition at line 959 of file SGVector.cpp.

◆ copy_data()

void copy_data ( const SGReferencedData & orig )

protectedvirtual

needs to be overridden to copy data

Implements SGReferencedData.

Definition at line 352 of file SGVector.cpp.

◆ copy_refcount()

void copy_refcount ( const SGReferencedData & orig )

protectedinherited

copy refcount

Definition at line 55 of file SGReferencedData.cpp.

◆ data()

T* data ( ) const

Data pointer

Definition at line 139 of file SGVector.h.

◆ display_size()

void display_size ( ) const

Display array size

Definition at line 345 of file SGVector.cpp.

◆ display_vector() [1/17]

void display_vector	(	const bool *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 410 of file SGVector.cpp.

◆ display_vector() [2/17]

void display_vector	(	const char *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 421 of file SGVector.cpp.

◆ display_vector() [3/17]

void display_vector	(	const uint8_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 432 of file SGVector.cpp.

◆ display_vector() [4/17]

void display_vector	(	const char *	name = `"vector"`,
		const char *	prefix = `""`
	)		const

Display vector

Definition at line 396 of file SGVector.cpp.

◆ display_vector() [5/17]

static void display_vector	(	const T *	vector,
		int32_t	n,
		const char *	name = `"vector"`,
		const char *	prefix = `""`
	)

static

Display vector (useful for debugging)

◆ display_vector() [6/17]

void display_vector	(	const int8_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 443 of file SGVector.cpp.

◆ display_vector() [7/17]

void display_vector	(	const SGVector< T >	vector,
		const char *	name = `"vector"`,
		const char *	prefix = `""`
	)

static

Display vector (useful for debugging)

Definition at line 403 of file SGVector.cpp.

◆ display_vector() [8/17]

void display_vector	(	const uint16_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 454 of file SGVector.cpp.

◆ display_vector() [9/17]

void display_vector	(	const int16_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 465 of file SGVector.cpp.

◆ display_vector() [10/17]

void display_vector	(	const int32_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 476 of file SGVector.cpp.

◆ display_vector() [11/17]

void display_vector	(	const uint32_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 487 of file SGVector.cpp.

◆ display_vector() [12/17]

void display_vector	(	const int64_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 499 of file SGVector.cpp.

◆ display_vector() [13/17]

void display_vector	(	const uint64_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 510 of file SGVector.cpp.

◆ display_vector() [14/17]

void display_vector	(	const float32_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 521 of file SGVector.cpp.

◆ display_vector() [15/17]

void display_vector	(	const float64_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 532 of file SGVector.cpp.

◆ display_vector() [16/17]

void display_vector	(	const floatmax_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 543 of file SGVector.cpp.

◆ display_vector() [17/17]

void display_vector	(	const complex128_t *	vector,
		int32_t	n,
		const char *	name,
		const char *	prefix
	)

Definition at line 557 of file SGVector.cpp.

◆ equals()

bool equals ( SGVector< T > & other )

Equals method up to precision for vectors (element-wise)

Parameters

other vector to compare with

Returns: false if any element differs or if sizes are different, true otherwise

Definition at line 380 of file SGVector.cpp.

◆ fill_vector()

void fill_vector	(	T *	vec,
		int32_t	len,
		T	value
	)

static

Fill vector

Definition at line 264 of file SGVector.cpp.

◆ find()

SGVector< index_t > find ( T elem )

Find index for occurance of an element

Parameters

elem	the element to find

Definition at line 849 of file SGVector.cpp.

◆ find_if()

SGVector<index_t> find_if ( Predicate p )

Find index for elements where the predicate returns true

Parameters

p	the predicate, it should accept the value of the element and return a bool

Definition at line 457 of file SGVector.h.

◆ find_position_to_insert() [1/2]

index_t find_position_to_insert ( T element )

For a sorted (ascending) vector, gets the index after the first element that is smaller than the given one

Parameters

element element to find index for

Returns: index of the first element greater than given one

Definition at line 226 of file SGVector.cpp.

◆ find_position_to_insert() [2/2]

index_t find_position_to_insert ( complex128_t element )

Definition at line 239 of file SGVector.cpp.

◆ free_data()

void free_data ( )

protectedvirtual

needs to be overridden to free data

Implements SGReferencedData.

Definition at line 371 of file SGVector.cpp.

◆ get()

SGVector<T> get ( )

Get the vector (no copying is done here)

Returns: the refcount increased vector

Definition at line 120 of file SGVector.h.

◆ get_element()

const T& get_element ( index_t index )

Get element at index

Parameters

index index

Returns: element at index

Definition at line 195 of file SGVector.h.

◆ get_imag()

SGVector< float64_t > get_imag ( )

Imag part of a complex128_t vector

Definition at line 935 of file SGVector.cpp.

◆ get_real()

SGVector< float64_t > get_real ( )

Real part of a complex128_t vector

Definition at line 926 of file SGVector.cpp.

◆ init_data()

void init_data ( )

protectedvirtual

needs to be overridden to initialize empty data

Implements SGReferencedData.

Definition at line 362 of file SGVector.cpp.

◆ load() [1/2]

void load ( CFile * loader )

Load vector from file

Parameters

loader File object via which to load data

Definition at line 889 of file SGVector.cpp.

◆ load() [2/2]

void load ( CFile * loader )

Definition at line 905 of file SGVector.cpp.

◆ on_gpu()

bool on_gpu ( ) const

Check whether data is stored on GPU

Returns: true if vector is on GPU

Definition at line 83 of file SGVector.h.

◆ onenorm()

float64_t onenorm	(	T *	x,
		int32_t	len
	)

static

|| x ||_1

Definition at line 755 of file SGVector.cpp.

◆ operator EigenRowVectorXtMap()

operator EigenRowVectorXtMap ( ) const

Wraps an Eigen3 row vector around the data of this matrix

Definition at line 161 of file SGVector.cpp.

◆ operator EigenVectorXtMap()

operator EigenVectorXtMap ( ) const

Wraps an Eigen3 column vector around the data of this matrix

Definition at line 154 of file SGVector.cpp.

◆ operator T*()

operator T* ( )

Cast to pointer

Definition at line 148 of file SGVector.h.

◆ operator+()

SGVector< T > operator+ ( SGVector< T > x )

Addition operator

addition operator

Definition at line 298 of file SGVector.cpp.

◆ operator+=() [1/2]

SGVector<T> operator+= ( SGVector< T > x )

Inplace addition operator

Definition at line 327 of file SGVector.h.

◆ operator+=() [2/2]

SGVector<T> operator+= ( SGSparseVector< T > & x )

static T product	(	T *	vec,
		int32_t	len
	)

static

Return the product of the vectors elements.

Definition at line 408 of file SGVector.h.

◆ product() [2/2]

T product ( )

Return product(vec)

Definition at line 418 of file SGVector.h.

◆ qnorm() [1/2]

T qnorm	(	T *	x,
		int32_t	len,
		float64_t	q
	)

static

|| x ||_q

Definition at line 784 of file SGVector.cpp.

◆ qnorm() [2/2]

complex128_t qnorm	(	complex128_t *	x,
		int32_t	len,
		float64_t	q
	)

Definition at line 791 of file SGVector.cpp.

◆ qsq() [1/2]

T qsq	(	T *	x,
		int32_t	len,
		float64_t	q
	)

static

|| x ||_q^q

Definition at line 766 of file SGVector.cpp.

◆ qsq() [2/2]

complex128_t qsq	(	complex128_t *	x,
		int32_t	len,
		float64_t	q
	)

Definition at line 776 of file SGVector.cpp.

◆ random()

void random	(	T	min_value,
		T	max_value
	)

Create random vector

Parameters

min_value	[min_value,max_value]
max_value

Definition at line 217 of file SGVector.cpp.

◆ random_vector() [1/2]

void random_vector	(	T *	vec,
		int32_t	len,
		T	min_value,
		T	max_value
	)

static

Random vector

Definition at line 605 of file SGVector.cpp.

◆ random_vector() [2/2]

void random_vector	(	complex128_t *	vec,
		int32_t	len,
		complex128_t	min_value,
		complex128_t	max_value
	)

Definition at line 612 of file SGVector.cpp.

◆ range_fill()

void range_fill ( T start = 0 )

Range fill a vector with start...start+len-1

Parameters

start - value to be assigned to first element of vector

Definition at line 208 of file SGVector.cpp.

◆ range_fill_vector() [1/2]

void range_fill_vector	(	T *	vec,
		int32_t	len,
		T	start = `0`
	)

static

Range fill vector

Definition at line 271 of file SGVector.cpp.

◆ range_fill_vector() [2/2]

void range_fill_vector	(	complex128_t *	vec,
		int32_t	len,
		complex128_t	start
	)

Definition at line 278 of file SGVector.cpp.

◆ ref()

int32_t ref ( )

protectedinherited

increase reference counter

Returns: reference count

Definition at line 64 of file SGReferencedData.cpp.

◆ ref_count()

int32_t ref_count ( )

inherited

display reference counter

Returns: reference count

Definition at line 41 of file SGReferencedData.cpp.

◆ resize_vector()

void resize_vector ( int32_t n )

Resize vector, with zero padding

Parameters

n new size

Definition at line 286 of file SGVector.cpp.

◆ save() [1/2]

void save ( CFile * saver )

Save vector to file

Parameters

saver File object via which to save data

Definition at line 910 of file SGVector.cpp.

◆ save() [2/2]

void save ( CFile * saver )

Definition at line 921 of file SGVector.cpp.

◆ scale()

void scale ( T alpha )

Scale vector inplace.

Definition at line 884 of file SGVector.cpp.

◆ scale_vector() [1/3]

void scale_vector	(	T	alpha,
		T *	vec,
		int32_t	len
	)

static

Scale vector inplace.

Definition at line 863 of file SGVector.cpp.

◆ scale_vector() [2/3]

void scale_vector	(	float64_t	alpha,
		float64_t *	vec,
		int32_t	len
	)

Definition at line 871 of file SGVector.cpp.

◆ scale_vector() [3/3]

void scale_vector	(	float32_t	alpha,
		float32_t *	vec,
		int32_t	len
	)

Definition at line 877 of file SGVector.cpp.

◆ set()

void set ( SGVector< T > orig )

Wrapper for the copy constructor useful for SWIG interfaces

Parameters

orig	vector to set

Definition at line 128 of file SGVector.cpp.

◆ set_const()

void set_const ( T const_elem )

Set vector to a constant

Parameters

const_elem - value to set vector to

Definition at line 184 of file SGVector.cpp.

◆ set_element()

void set_element	(	const T &	el,
		index_t	index
	)

Set element at index

Parameters

el	element to set
index	index

Definition at line 205 of file SGVector.h.

◆ size()

int32_t size ( ) const

Size

Definition at line 136 of file SGVector.h.

◆ sum() [1/2]

static T sum	(	T *	vec,
		int32_t	len
	)

static

Return sum(vec)

Definition at line 392 of file SGVector.h.

◆ sum() [2/2]

static T sum ( SGVector< T > vec )

static

Return sum(vec)

Definition at line 402 of file SGVector.h.

◆ sum_abs() [1/3]

T sum_abs	(	T *	vec,
		int32_t	len
	)

static

return sum(abs(vec))

Returns: sum(abs(vec))

Definition at line 799 of file SGVector.cpp.

◆ sum_abs() [2/3]

float64_t sum_abs	(	float64_t *	vec,
		int32_t	len
	)

Definition at line 810 of file SGVector.cpp.

◆ sum_abs() [3/3]

float32_t sum_abs	(	float32_t *	vec,
		int32_t	len
	)

Definition at line 818 of file SGVector.cpp.

◆ twonorm() [1/15]

static T twonorm	(	const T *	x,
		int32_t	len
	)

static

|| x ||_2

◆ twonorm() [2/15]

bool twonorm	(	const bool *	x,
		int32_t	len
	)

Definition at line 619 of file SGVector.cpp.

◆ twonorm() [3/15]

char twonorm	(	const char *	x,
		int32_t	len
	)

Definition at line 626 of file SGVector.cpp.

◆ twonorm() [4/15]

int8_t twonorm	(	const int8_t *	x,
		int32_t	len
	)

Definition at line 633 of file SGVector.cpp.

◆ twonorm() [5/15]

uint8_t twonorm	(	const uint8_t *	x,
		int32_t	len
	)

Definition at line 643 of file SGVector.cpp.

◆ twonorm() [6/15]

int16_t twonorm	(	const int16_t *	x,
		int32_t	len
	)

Definition at line 653 of file SGVector.cpp.

◆ twonorm() [7/15]

uint16_t twonorm	(	const uint16_t *	x,
		int32_t	len
	)

Definition at line 663 of file SGVector.cpp.

◆ twonorm() [8/15]

int32_t twonorm	(	const int32_t *	x,
		int32_t	len
	)

Definition at line 673 of file SGVector.cpp.

◆ twonorm() [9/15]

uint32_t twonorm	(	const uint32_t *	x,
		int32_t	len
	)

Definition at line 683 of file SGVector.cpp.

◆ twonorm() [10/15]

int64_t twonorm	(	const int64_t *	x,
		int32_t	len
	)

Definition at line 693 of file SGVector.cpp.

◆ twonorm() [11/15]

uint64_t twonorm	(	const uint64_t *	x,
		int32_t	len
	)

Definition at line 703 of file SGVector.cpp.

◆ twonorm() [12/15]

float32_t twonorm	(	const float32_t *	x,
		int32_t	len
	)

Definition at line 713 of file SGVector.cpp.

◆ twonorm() [13/15]

float64_t twonorm	(	const float64_t *	v,
		int32_t	n
	)

Definition at line 723 of file SGVector.cpp.

◆ twonorm() [14/15]

floatmax_t twonorm	(	const floatmax_t *	x,
		int32_t	len
	)

Definition at line 735 of file SGVector.cpp.

◆ twonorm() [15/15]

complex128_t twonorm	(	const complex128_t *	x,
		int32_t	len
	)

Definition at line 745 of file SGVector.cpp.

◆ unique() [1/2]

int32_t unique	(	T *	output,
		int32_t	size
	)

static

Performs a inplace unique of a vector of type T using quicksort returns the new number of elements

Definition at line 827 of file SGVector.cpp.

◆ unique() [2/2]

int32_t unique	(	complex128_t *	output,
		int32_t	size
	)

Definition at line 841 of file SGVector.cpp.

◆ unref()

int32_t unref ( )

protectedinherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns: reference count

Definition at line 84 of file SGReferencedData.cpp.

◆ vec1_plus_scalar_times_vec2() [1/3]

void vec1_plus_scalar_times_vec2	(	T *	vec1,
		const T	scalar,
		const T *	vec2,
		int32_t	n
	)

static

x=x+alpha*y

Definition at line 571 of file SGVector.cpp.

◆ vec1_plus_scalar_times_vec2() [2/3]

void vec1_plus_scalar_times_vec2	(	float64_t *	vec1,
		float64_t	scalar,
		const float64_t *	vec2,
		int32_t	n
	)

Definition at line 579 of file SGVector.cpp.

◆ vec1_plus_scalar_times_vec2() [3/3]

void vec1_plus_scalar_times_vec2	(	float32_t *	vec1,
		float32_t	scalar,
		const float32_t *	vec2,
		int32_t	n
	)

Definition at line 592 of file SGVector.cpp.

◆ vector_multiply()

static void vector_multiply	(	T *	target,
		const T *	v1,
		const T *	v2,
		int32_t	len
	)

static

Compute vector multiplication.

Definition at line 364 of file SGVector.h.

◆ zero() [1/2]

void zero ( )

Fill vector with zeros

Definition at line 168 of file SGVector.cpp.

◆ zero() [2/2]

void zero ( )

Definition at line 176 of file SGVector.cpp.

Friends And Related Function Documentation

◆ LinalgBackendEigen

friend class LinalgBackendEigen

friend

Definition at line 44 of file SGVector.h.

Member Data Documentation

◆ gpu_ptr

std::shared_ptr<GPUMemoryBase<T> > gpu_ptr

GPU Vector structure. Stores pointer to the data on GPU.

Definition at line 547 of file SGVector.h.

◆ vector

T* vector

Pointer to memory where vector data is stored

Definition at line 543 of file SGVector.h.

◆ vlen

index_t vlen

Length of vector

Definition at line 545 of file SGVector.h.

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

Detailed Description

template<class T> class shogun::SGVector< T >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Friends

Member Typedef Documentation

◆ EigenRowVectorXt

◆ EigenRowVectorXtMap

◆ EigenVectorXt

◆ EigenVectorXtMap

◆ Scalar

Constructor & Destructor Documentation

◆ SGVector() [1/8]

◆ SGVector() [2/8]

◆ SGVector() [3/8]

◆ SGVector() [4/8]

◆ SGVector() [5/8]

◆ SGVector() [6/8]

◆ SGVector() [7/8]

◆ SGVector() [8/8]

◆ ~SGVector()

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ add_scalar()

◆ clone()

◆ clone_vector()

◆ convert_to_matrix() [1/2]

◆ convert_to_matrix() [2/2]

◆ copy_data()

◆ copy_refcount()

◆ data()

◆ display_size()

◆ display_vector() [1/17]

◆ display_vector() [2/17]

◆ display_vector() [3/17]

◆ display_vector() [4/17]

◆ display_vector() [5/17]

◆ display_vector() [6/17]

◆ display_vector() [7/17]

◆ display_vector() [8/17]

◆ display_vector() [9/17]

◆ display_vector() [10/17]

◆ display_vector() [11/17]

◆ display_vector() [12/17]

◆ display_vector() [13/17]

◆ display_vector() [14/17]

◆ display_vector() [15/17]

◆ display_vector() [16/17]

◆ display_vector() [17/17]

◆ equals()

◆ fill_vector()

◆ find()

◆ find_if()

◆ find_position_to_insert() [1/2]

◆ find_position_to_insert() [2/2]

◆ free_data()

◆ get()

◆ get_element()

◆ get_imag()

◆ get_real()

◆ init_data()

◆ load() [1/2]

◆ load() [2/2]

◆ on_gpu()

◆ onenorm()

◆ operator EigenRowVectorXtMap()

◆ operator EigenVectorXtMap()

◆ operator T*()

◆ operator+()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator=()

◆ operator[]() [1/8]

◆ operator[]() [2/8]

template<class T>
class shogun::SGVector< T >