LaVectorInt Class Reference

Vector class for integers. More...

#include <lavi.h>

Inheritance diagram for LaVectorInt:

List of all members.

Declaration
	LaVectorInt ()
	LaVectorInt (int n)
	LaVectorInt (int m, int n)
	LaVectorInt (int *v, int n)
	LaVectorInt (int *v, int m, int n)
	LaVectorInt (const LaGenMatInt &)
	LaVectorInt (const LaIndex &ind)
Information
int	size () const
int	inc () const
int	start () const
int	end () const
LaIndex	index () const
Access functions
int &	operator() (int i)
int &	operator() (int i) const
LaVectorInt	operator() (const LaIndex &)
Assignments
LaVectorInt &	operator= (int)
LaVectorInt &	operator= (const LaGenMatInt &)
LaVectorInt &	inject (const LaGenMatInt &)
LaVectorInt &	copy (const LaGenMatInt &)
LaVectorInt &	ref (const LaGenMatInt &)

---

Detailed Description

Vector class for integers.

A vector is simply an nx1 or 1xn, matrix, only that it can be constructed and accessed by a single dimension.

---

Constructor & Destructor Documentation

LaVectorInt::LaVectorInt

(

)

[inline]

Constructs a column vector of length 0 (null).

LaVectorInt::LaVectorInt

(

int

n

)

[inline]

Constructs a column vector of length n

LaVectorInt::LaVectorInt	(	int	m,
		int	n
	)			[inline]

Constructs a vector of size . One of the two dimensions must be one!

LaVectorInt::LaVectorInt	(	int *	v,
		int	n
	)			[inline]

Constructs a column vector of length n by copying the values from a one-dimensional C array of length n.

LaVectorInt::LaVectorInt	(	int *	v,
		int	m,
		int	n
	)			[inline]

Constructs an vector by copying the values from a one-dimensional C array of length mn. One of the two dimensions must be one!

LaVectorInt::LaVectorInt

(

const LaGenMatInt &

)

[inline]

Create a new vector from an existing matrix by copying. The given matrix s must be a vector, i.e. one of its dimensions must be one!

LaVectorInt::LaVectorInt

(

const LaIndex &

ind

)

Create this integer vector from the index counting of this LaIndex() object.

---

Member Function Documentation

int LaVectorInt::size

(

)

const [inline]

Returns the length n of this vector.

int LaVectorInt::inc

(

)

const [inline]

Returns the distance between memory locations (in terms of number of elements) between consecutive elements along dimension d. For example, if inc(d) returns 1, then elements along the dth dimension are contiguous in memory.

int LaVectorInt::start

(

)

const [inline]

If the memory space used by this matrix is viewed as a linear array, start(d) returns the starting offset of the first element in dimension d. (See LaIndex class.)

int LaVectorInt::end

(

)

const [inline]

If the memory space used by this matrix is viewed as a linear array, end(d) returns the starting offset of the last element in dimension d. (See LaIndex class.)

LaIndex LaVectorInt::index

(

)

const [inline]

Returns the index specifying this submatrix view in dimension d. (See LaIndex class.) This will only differ from a unit-stride index is the current matrix is actually a submatrix view of some larger matrix.

int & LaVectorInt::operator()

(

int

i

)

[inline]

Returns the th element of this vector, with the index i starting at zero (zero-based offset). This means you have

but for accessing the element you have to write v(0).

Optional runtime bounds checking (0<=i<=n) is set by the compile time macro LA_BOUNDS_CHECK.

int & LaVectorInt::operator()

(

int

i

)

const [inline]

Returns the th element of this vector, with the index i starting at zero (zero-based offset). This means you have

but for accessing the element you have to write v(0).

Optional runtime bounds checking (0<=i<=n) is set by the compile time macro LA_BOUNDS_CHECK.

LaVectorInt LaVectorInt::operator()

(

const LaIndex &

)

[inline]

Return a submatrix view specified by the index I. (See LaIndex class.) These indices specify start, increment, and ending offsets, similar to triplet notation of Matlab or Fortran 90. For example, if B is a 10 x 10 matrix, I is (0:2:2) and J is (3:1:4), then B(I,J) denotes the 2 x 2 matrix

LaVectorInt & LaVectorInt::operator=

(

int

)

[inline]

Set elements of left-hand size to the scalar value s. No new vector is created, so that if there are other vectors that reference this memory space, they will also be affected.

Reimplemented from LaGenMatInt.

LaVectorInt & LaVectorInt::operator=

(

const LaGenMatInt &

)

[inline]

Release left-hand side (reclaiming memory space if possible) and copy elements of elements of s. Unline inject(), it does not require conformity, and previous references of left-hand side are unaffected.

This is an alias for copy().

Reimplemented from LaGenMatInt.

LaVectorInt & LaVectorInt::inject

(

const LaGenMatInt &

)

[inline]

Copy elements of s into the memory space referenced by the left-hand side, without first releasing it. The effect is that if other vectors share memory with left-hand side, they too will be affected. Note that the size of s must be the same as that of the left-hand side vector.

Note:

If you rather wanted to create a new copy of s, you should use copy() instead.

Reimplemented from LaGenMatInt.

LaVectorInt & LaVectorInt::copy

(

const LaGenMatInt &

)

[inline]

Release left-hand side (reclaiming memory space if possible) and copy elements of elements of s. Unline inject(), it does not require conformity, and previous references of left-hand side are unaffected.

Reimplemented from LaGenMatInt.

LaVectorInt & LaVectorInt::ref

(

const LaGenMatInt &

)

[inline]

Let this vector reference the given vector s, so that the given vector memory s is now referenced by multiple objects (by the given object s and now also by this object). Handle this with care!

This function releases any previously referenced memory of this object.

Reimplemented from LaGenMatInt.

---