matpackIII.h File Reference

#include "matpackI.h"

Go to the source code of this file.

Classes
class	Iterator3D
	Implementation of Tensors of Rank 3. More...
class	ConstIterator3D
	Const version of Iterator3D. More...
class	ConstTensor3View
	A constant view of a Tensor3. More...
class	Tensor3View
	The Tensor3View class. More...
class	Tensor3
	The Tensor3 class. More...

Functions
void	copy (ConstIterator3D origin, const ConstIterator3D &end, Iterator3D target)
	Copy data between begin and end to target. More...
void	copy (Numeric x, Iterator3D target, const Iterator3D &end)
	Copy a scalar to all elements. More...
void	transform (Tensor3View y, double(&my_func)(double), ConstTensor3View x)
	A generic transform function for tensors, which can be used to implement mathematical functions operating on all elements. More...
Numeric	max (const ConstTensor3View &x)
	Max function, tensor version. More...
Numeric	min (const ConstTensor3View &x)
	Min function, tensor version. More...
ostream &	operator<< (ostream &os, const ConstTensor3View &v)
	Output operator. More...
Numeric	debug_tensor3view_get_elem (Tensor3View &tv, Index p, Index r, Index c)
	Helper function to access tensor elements. More...

Function Documentation

copy() [1/2]

void copy	(	ConstIterator3D	origin,
		const ConstIterator3D &	end,
		Iterator3D	target
	)

Copy data between begin and end to target.

Target must be a valid area of memory. Note that the strides in the iterators can be different, so that we can copy data between different kinds of subtensors.

Definition at line 725 of file matpackIII.cc.

References ConstMatrixView::begin(), MatrixView::begin(), copy(), and ConstMatrixView::end().

Referenced by copy(), Tensor3View::operator=(), Tensor3::operator=(), and Tensor3::Tensor3().

copy() [2/2]

void copy	(	Numeric	x,
		Iterator3D	target,
		const Iterator3D &	end
	)

Copy a scalar to all elements.

Definition at line 740 of file matpackIII.cc.

References MatrixView::begin(), copy(), and MatrixView::end().

debug_tensor3view_get_elem()

Numeric debug_tensor3view_get_elem	(	Tensor3View &	tv,
		Index	p,
		Index	r,
		Index	c
	)

Helper function to access tensor elements.

Because of function inlining the operator() is not accessible from the debuggger. This function helps to access Tensor elements from within the debugger.

Parameters

tv	TensorView
p	Page index
r	Row index
c	Column index

Author

Oliver Lemke

Date

2004-05-10

Definition at line 998 of file matpackIII.cc.

max()

Numeric max

(

const ConstTensor3View &

x

)

Max function, tensor version.

Definition at line 936 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), and max().

Referenced by max().

min()

Numeric min

(

const ConstTensor3View &

x

)

Min function, tensor version.

Definition at line 958 of file matpackIII.cc.

References ConstTensor3View::begin(), ConstTensor3View::end(), and min().

Referenced by min().

operator<<()

ostream& operator<<	(	ostream &	os,
		const ConstTensor3View &	v
	)

Output operator.

This demonstrates how iterators can be used to traverse the tensor. We use the standard output operator for Matrix to print each page in turn.

Definition at line 218 of file matpackIII.cc.

References ConstTensor3View::begin(), and ConstTensor3View::end().

transform()

void transform	(	Tensor3View	y,
		double(&)(double)	my_func,
		ConstTensor3View	x
	)

A generic transform function for tensors, which can be used to implement mathematical functions operating on all elements.

Because we have this, we don't need explicit functions like sqrt for tensors! The type of the mathematical function is double (&my_func)(double). Numeric would not work here, since mathematical functions for float do not exist!

transform(y,sin,x) computes y = sin(x)

The two views may be the same one, in which case the conversion happens in place.

Parameters

y	Output: The results of the function acting on each element of x.
my_func	A function (e.g., sqrt).
x	A tensor.

Definition at line 915 of file matpackIII.cc.

References ConstTensor3View::begin(), Tensor3View::begin(), ConstTensor3View::end(), ConstTensor3View::ncols(), ConstTensor3View::npages(), ConstTensor3View::nrows(), and transform().

Referenced by transform().