seq Class Reference

sequential index generator More...

#include <index.h>

Public Member Functions
	seq ()
	seq (double n)
	Create sequence {0 1 ... n-1}. More...
	seq (double first, double last)
	Create sequence {first first+1 ... last}. More...
	seq (double first, double inc, double last)
	Create sequence {first first+inc ... last}. More...
seq	operator- ()
	Negative sequence. More...
seq	operator+ (double x)
	Offset sequence. More...
seq	operator- (double x)
	Offset sequence. More...
seq	operator* (double x)
	Scale offset sequence. More...

Data Fields
double	first
	Starting value of the sequence. More...
double	inc
	Increment size. More...
double	last
	Ending value of the sequence. More...
unsigned	size
	Number of elements in the sequence. More...

Friends
seq	operator+ (double x, seq y)
	Offset sequence. More...
seq	operator- (double x, seq y)
	Offset sequence. More...
seq	operator* (double x, seq y)
	Scale offset sequence. More...

Detailed Description

sequential index generator

Examples:

examples/helloworld/helloworld.cpp, examples/machine_learning/neuralnetwork.cpp, examples/pde/fdtd.cpp, examples/pde/swe.cpp, and examples/visualization/blip.cpp.

Constructor & Destructor Documentation

seq

(

)

seq ( double  n )

explicit

Create sequence {0 1 ... n-1}.

The values begin at 0 and are increment by 1 till n-1.

array a = seq(5);   //a = [0, 1, 2, 3, 4]

Parameters

n	size of the sequence to generate

Returns

seq of values 0 to n-1

seq	(	double	first,
		double	last
	)

Create sequence {first first+1 ... last}.

The values begin at first and are incremented by 1 till last.

array a = seq(5, 10);   //a = [5, 6, 7, 8, 9, 10]

Parameters

first	starting value of sequence to generate
last	ending value of sequence to generate (inclusive)

Returns

seq of values first to last

seq	(	double	first,
		double	inc,
		double	last
	)

Create sequence {first first+inc ... last}.

The values begin with first and are incremented by inc till last.

array a = seq(1, 2, 10);   //a = [1, 3, 5, 7, 9]

Parameters

first	starting value of sequence to generate
inc	increment step
last	ending value of sequence to generate

Returns

seq of values first to last with inc increments

Member Function Documentation

seq operator- ( )

inline

Negative sequence.

Creates a seq and negates the values.

array a(-seq(5)); //a=[-0 -1 -2 -3 -4]

seq operator+ ( double  x )

inline

Offset sequence.

Add an offset to a sequence.

array b(seq(5)+1); //b=[1 2 3 4 5]

seq operator- ( double  x )

inline

Offset sequence.

Subtract an offset from a sequence.

array a(seq(5)-1); //a=[-1 0 1 2 3]

seq operator* ( double  x )

inline

Scale offset sequence.

Multiply an offset to a sequence.

array a(seq(5)*3); //a=[0 3 6 9 12]

Friends And Related Function Documentation

seq operator+ ( double  x, seq  y  )

friend

Offset sequence.

Add an offset to a sequence.

array b(1+seq(5)); //b=[1 2 3 4 5]

seq operator- ( double  x, seq  y  )

friend

Offset sequence.

Subtract an offset from a sequence.

array a(1-seq(5)); //a=[1  0 -1 -2 -3]

seq operator* ( double  x, seq  y  )

friend

Scale offset sequence.

Multiply an offset to a sequence.

array a(seq(5)*3); //a=[0 3 6 9 12]

Field Documentation

double first

Starting value of the sequence.

double inc

Increment size.

double last

Ending value of the sequence.

unsigned size

Number of elements in the sequence.

---

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

• index.h (2014-04-30 15:38:09 -0400, (build fd32605))