elmatfunc.h File Reference

Definitions of elementary functions on vectors and matrices. More...

#include <itpp/base/help_functions.h>
#include <itpp/base/converters.h>

Go to the source code of this file.

Namespaces

namespace itpp

Functions

itpp::vec gamma (const itpp::vec &x)

The gamma function.

itpp::mat gamma (const itpp::mat &x)

The gamma function.

vec exp (const vec &x)

Exp of the elements.

cvec exp (const cvec &x)

Exp of cvec.

mat exp (const mat &x)

Exp of the elements.

cmat exp (const cmat &x)

Exp of cmat.

vec pow (const double x, const vec &y)

Calculates x to the power of y (x^y).

mat pow (const double x, const mat &y)

Calculates x to the power of y (x^y).

vec pow (const vec &x, const double y)

Calculates x to the power of y (x^y).

mat pow (const mat &x, const double y)

Calculates x to the power of y (x^y).

vec pow2 (const vec &x)

Calculates two to the power of x (2^x).

mat pow2 (const mat &x)

Calculates two to the power of x (2^x).

vec pow10 (const vec &x)

Calculates ten to the power of x (10^x).

mat pow10 (const mat &x)

Calculates ten to the power of x (10^x).

vec log (const vec &x)

The natural logarithm of the elements.

mat log (const mat &x)

The natural logarithm of the elements.

cvec log (const cvec &x)

The natural logarithm of the elements.

cmat log (const cmat &x)

The natural logarithm of the elements.

vec log2 (const vec &x)

log-2 of the elements

mat log2 (const mat &x)

log-2 of the elements

vec log10 (const vec &x)

log-10 of the elements

mat log10 (const mat &x)

log-10 of the elements

vec logb (const short b, const vec &x)

log-b of x

mat logb (const short b, const mat &x)

log-b of x

vec dB (const vec &x)

Calculates 10*log10(x).

mat dB (const mat &x)

Calculates 10*log10(x).

vec inv_dB (const vec &x)

Calulates the inverse of dB, 10^(x/10).

mat inv_dB (const mat &x)

Calculates the inverse of dB, 10^(x/10).

vec erf (const vec &x)

Error function.

mat erf (const mat &x)

Error function.

cvec erf (const cvec &x)

Error function.

cmat erf (const cmat &x)

Error function.

vec erfinv (const vec &x)

Inverse of error function.

mat erfinv (const mat &x)

Inverse of error function.

vec erfc (const vec &x)

Complementary error function.

mat erfc (const mat &x)

Complementary error function.

vec Qfunc (const vec &x)

Q-function.

mat Qfunc (const mat &x)

Q-function.

vec sin (const vec &x)

Sine function.

mat sin (const mat &x)

Sine function.

vec cos (const vec &x)

Cosine function.

mat cos (const mat &x)

Cosine function.

vec tan (const vec &x)

Tan function.

mat tan (const mat &x)

Tan function.

vec asin (const vec &x)

Inverse sine function.

mat asin (const mat &x)

Inverse sine function.

vec acos (const vec &x)

Inverse cosine function.

mat acos (const mat &x)

Inverse cosine function.

vec atan (const vec &x)

Inverse tan function.

mat atan (const mat &x)

Inverse tan function.

vec sinc (const vec &x)

Sinc function, sin(pi*x)/(pi*x).

mat sinc (const mat &x)

Sinc function, sin(pi*x)/(pi*x).

vec sinh (const vec &x)

Sine hyperbolic function.

mat sinh (const mat &x)

Sine hyperbolic function.

vec cosh (const vec &x)

Cosine hyperbolic function.

mat cosh (const mat &x)

Cosine hyperbolic function.

vec tanh (const vec &x)

Tan hyperbolic function.

mat tanh (const mat &x)

Tan hyperbolic function.

vec asinh (const vec &x)

Inverse sine hyperbolic function.

mat asinh (const mat &x)

Inverse sine hyperbolic function.

vec acosh (const vec &x)

Inverse cosine hyperbolic function.

mat acosh (const mat &x)

Inverse cosine hyperbolic function.

vec atanh (const vec &x)

Inverse tan hyperbolic function.

mat atanh (const mat &x)

Inverse tan hyperbolic function.

vec ceil (const vec &x)

Round to nearest upper integer.

mat ceil (const mat &x)

Round to nearest upper integer.

vec floor (const vec &x)

Round to nearest lower integer.

mat floor (const mat &x)

Round to nearest lower integer.

vec round (const vec &x)

Round to nearest integer.

mat round (const mat &x)

Round to nearest integer.

ivec round_i (const vec &x)

Round to nearest integer and return ivec.

imat round_i (const mat &x)

Round to nearest integer and return imat.

vec abs (const vec &x)

Absolute value.

mat abs (const mat &x)

Absolute value.

vec sqr (const vec &x)

Square of elements.

mat sqr (const mat &x)

Square of elements.

vec sign (const vec &x)

Signum function.

mat sign (const mat &x)

Signum function.

vec sqrt (const vec &x)

Square root of the elements.

mat sqrt (const mat &x)

Square root of the elements.

vec rem (const vec &x, const double &y)

Elementwise reminder of the division x/y for vec and double.

vec rem (const double &x, const vec &y)

Elementwise reminder of the division x/y for double and vec.

mat rem (const mat &x, const double &y)

Elementwise reminder of the division x/y for mat and double.

mat rem (const double &x, const mat &y)

Elementwise reminder of the division x/y for double and mat.

vec angle (const cvec &x)

Angle.

mat angle (const cmat &x)

Angle.

vec round_to_zero (const vec &x, double threshold=1e-14)

Round each element to zero if element < threshold.

mat round_to_zero (const mat &x, double threshold=1e-14)

Round each element to zero if element < threshold.

Detailed Description

Definitions of elementary functions on vectors and matrices.

Author:: Tony Ottosson

Date: 2007-04-18 08:58:29 +0200 (Wed, 18 Apr 2007)

Revision: 1013

-------------------------------------------------------------------------

IT++ - C++ library of mathematical, signal processing, speech processing, and communications classes and functions

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

-------------------------------------------------------------------------

Definition in file elmatfunc.h.

Generated on Fri Jan 11 08:51:39 2008 for IT++ by Doxygen 1.3.9.1


Namespaces
namespace	itpp
Functions
itpp::vec	gamma (const itpp::vec &x)
	The gamma function.
itpp::mat	gamma (const itpp::mat &x)
	The gamma function.
vec	exp (const vec &x)
	Exp of the elements.
cvec	exp (const cvec &x)
	Exp of cvec.
mat	exp (const mat &x)
	Exp of the elements.
cmat	exp (const cmat &x)
	Exp of cmat.
vec	pow (const double x, const vec &y)
	Calculates x to the power of y (x^y).
mat	pow (const double x, const mat &y)
	Calculates x to the power of y (x^y).
vec	pow (const vec &x, const double y)
	Calculates x to the power of y (x^y).
mat	pow (const mat &x, const double y)
	Calculates x to the power of y (x^y).
vec	pow2 (const vec &x)
	Calculates two to the power of x (2^x).
mat	pow2 (const mat &x)
	Calculates two to the power of x (2^x).
vec	pow10 (const vec &x)
	Calculates ten to the power of x (10^x).
mat	pow10 (const mat &x)
	Calculates ten to the power of x (10^x).
vec	log (const vec &x)
	The natural logarithm of the elements.
mat	log (const mat &x)
	The natural logarithm of the elements.
cvec	log (const cvec &x)
	The natural logarithm of the elements.
cmat	log (const cmat &x)
	The natural logarithm of the elements.
vec	log2 (const vec &x)
	log-2 of the elements
mat	log2 (const mat &x)
	log-2 of the elements
vec	log10 (const vec &x)
	log-10 of the elements
mat	log10 (const mat &x)
	log-10 of the elements
vec	logb (const short b, const vec &x)
	log-b of `x`
mat	logb (const short b, const mat &x)
	log-b of `x`
vec	dB (const vec &x)
	Calculates 10*log10(x).
mat	dB (const mat &x)
	Calculates 10*log10(x).
vec	inv_dB (const vec &x)
	Calulates the inverse of dB, 10^(x/10).
mat	inv_dB (const mat &x)
	Calculates the inverse of dB, 10^(x/10).
vec	erf (const vec &x)
	Error function.
mat	erf (const mat &x)
	Error function.
cvec	erf (const cvec &x)
	Error function.
cmat	erf (const cmat &x)
	Error function.
vec	erfinv (const vec &x)
	Inverse of error function.
mat	erfinv (const mat &x)
	Inverse of error function.
vec	erfc (const vec &x)
	Complementary error function.
mat	erfc (const mat &x)
	Complementary error function.
vec	Qfunc (const vec &x)
	Q-function.
mat	Qfunc (const mat &x)
	Q-function.
vec	sin (const vec &x)
	Sine function.
mat	sin (const mat &x)
	Sine function.
vec	cos (const vec &x)
	Cosine function.
mat	cos (const mat &x)
	Cosine function.
vec	tan (const vec &x)
	Tan function.
mat	tan (const mat &x)
	Tan function.
vec	asin (const vec &x)
	Inverse sine function.
mat	asin (const mat &x)
	Inverse sine function.
vec	acos (const vec &x)
	Inverse cosine function.
mat	acos (const mat &x)
	Inverse cosine function.
vec	atan (const vec &x)
	Inverse tan function.
mat	atan (const mat &x)
	Inverse tan function.
vec	sinc (const vec &x)
	Sinc function, sin(pix)/(pix).
mat	sinc (const mat &x)
	Sinc function, sin(pix)/(pix).
vec	sinh (const vec &x)
	Sine hyperbolic function.
mat	sinh (const mat &x)
	Sine hyperbolic function.
vec	cosh (const vec &x)
	Cosine hyperbolic function.
mat	cosh (const mat &x)
	Cosine hyperbolic function.
vec	tanh (const vec &x)
	Tan hyperbolic function.
mat	tanh (const mat &x)
	Tan hyperbolic function.
vec	asinh (const vec &x)
	Inverse sine hyperbolic function.
mat	asinh (const mat &x)
	Inverse sine hyperbolic function.
vec	acosh (const vec &x)
	Inverse cosine hyperbolic function.
mat	acosh (const mat &x)
	Inverse cosine hyperbolic function.
vec	atanh (const vec &x)
	Inverse tan hyperbolic function.
mat	atanh (const mat &x)
	Inverse tan hyperbolic function.
vec	ceil (const vec &x)
	Round to nearest upper integer.
mat	ceil (const mat &x)
	Round to nearest upper integer.
vec	floor (const vec &x)
	Round to nearest lower integer.
mat	floor (const mat &x)
	Round to nearest lower integer.
vec	round (const vec &x)
	Round to nearest integer.
mat	round (const mat &x)
	Round to nearest integer.
ivec	round_i (const vec &x)
	Round to nearest integer and return ivec.
imat	round_i (const mat &x)
	Round to nearest integer and return imat.
vec	abs (const vec &x)
	Absolute value.
mat	abs (const mat &x)
	Absolute value.
vec	sqr (const vec &x)
	Square of elements.
mat	sqr (const mat &x)
	Square of elements.
vec	sign (const vec &x)
	Signum function.
mat	sign (const mat &x)
	Signum function.
vec	sqrt (const vec &x)
	Square root of the elements.
mat	sqrt (const mat &x)
	Square root of the elements.
vec	rem (const vec &x, const double &y)
	Elementwise reminder of the division x/y for vec and double.
vec	rem (const double &x, const vec &y)
	Elementwise reminder of the division x/y for double and vec.
mat	rem (const mat &x, const double &y)
	Elementwise reminder of the division x/y for mat and double.
mat	rem (const double &x, const mat &y)
	Elementwise reminder of the division x/y for double and mat.
vec	angle (const cvec &x)
	Angle.
mat	angle (const cmat &x)
	Angle.
vec	round_to_zero (const vec &x, double threshold=1e-14)
	Round each element to zero if element < threshold.
mat	round_to_zero (const mat &x, double threshold=1e-14)
	Round each element to zero if element < threshold.