mathlib Namespace Reference

Enumerations
enum	MathError {   OK , DIVISION_BY_ZERO , NEGATIVE_FACTORIAL , INVALID_ROOT ,   INVALID_ARGUMENT }

Functions
double	add (double a, double b)
	Implementation of function add.
double	subtract (double a, double b)
	Implementation of function subtract.
double	multiply (double a, double b)
	Implementation of function multiply.
double	divide (double a, double b, MathError &err)
	Implementation of function divide.
double	factorial (int a, MathError &err)
	Implementation of function factorial.
double	power (double base, int exp)
	Implementation of function power.
double	root (double base, int n, MathError &err)
	Implementation of function root.
double	modulo (double a, double b, MathError &err)
	Implementation of function modulo.

Enumeration Type Documentation

MathError

enum mathlib::MathError

Enumerator
OK
DIVISION_BY_ZERO
NEGATIVE_FACTORIAL
INVALID_ROOT
INVALID_ARGUMENT

Definition at line 11 of file mathlib.h.

               {
    OK,
    DIVISION_BY_ZERO,
    NEGATIVE_FACTORIAL,
    INVALID_ROOT,
    INVALID_ARGUMENT,
};

Function Documentation

add()

double mathlib::add	(	double	a,
		double	b )

Implementation of function add.

Add two numbers.

Parameters

a	first number
b	second number

Returns

sum of a and b

Definition at line 9 of file mathlib.cpp.

                               {
 
    return a + b;
}

divide()

double mathlib::divide	(	double	a,
		double	b,
		MathError &	err )

Implementation of function divide.

Divide two numbers.

Parameters

a	first number
b	second number
err	error code (division by zero)

Returns

quotient of a and b

Definition at line 33 of file mathlib.cpp.

                                                  {
 
    if(b == 0) {
        err = DIVISION_BY_ZERO;
        return 0;
    }
 
    err = OK;
    return a / b;
}

factorial()

double mathlib::factorial	(	int	a,
		MathError &	err )

Implementation of function factorial.

Compute factorial of a number.

Parameters

a	input number (must be >= 0)
err	error code (negative input)

Returns

factorial of a

Definition at line 47 of file mathlib.cpp.

                                        {
 
    if(a < 0 ) {
        err = NEGATIVE_FACTORIAL;
        return 0;
    }
 
    err = OK;
 
    double result = 1;
    for(int i = 1; i <= a; i++) {
        result = result * i;
    }
 
    return result;
}

modulo()

double mathlib::modulo	(	double	a,
		double	b,
		MathError &	err )

Implementation of function modulo.

Compute modulo of two numbers.

Parameters

a	first number
b	second number
err	error code (division by zero)

Returns

remainder of a divided by b

Definition at line 111 of file mathlib.cpp.

                                                  {
 
    if(b == 0) {
        err = DIVISION_BY_ZERO;
        return 0;
    }
 
    err = OK;
 
    return std::fmod(a, b);
}

multiply()

double mathlib::multiply	(	double	a,
		double	b )

Implementation of function multiply.

Multiply two numbers.

Parameters

a	first number
b	second number

Returns

product of a and b

Definition at line 25 of file mathlib.cpp.

                                    {
 
    return a * b;
}

power()

double mathlib::power	(	double	base,
		int	exp )

Implementation of function power.

Raise a number to a natural exponent.

Parameters

base	input number
exp	exponent (must be >= 0)

Returns

base raised to the power of exponent

Definition at line 67 of file mathlib.cpp.

                                   {
 
    if(exp == 0) {
        return 1;
    }
 
    double result = 1;
 
    for(int i = 0; i < exp; i++) {
        result = result * base;
    }
 
    return result;
}

root()

double mathlib::root	(	double	base,
		int	n,
		MathError &	err )

Implementation of function root.

Compute n-th root of a number.

Parameters

base	input number
n	degree of the root (must be > 0)
err	error code (invalid root)

Returns

n-th root of base

Definition at line 85 of file mathlib.cpp.

                                                {
 
    if(n == 0) {
        err = INVALID_ROOT;
        return 0;
    }
    if(n < 0) {
        err = INVALID_ROOT;
        return 0;
    }
    if(base < 0 && n % 2 == 0) {
        err = INVALID_ARGUMENT;
        return 0;
    }
    if(base < 0 && n % 2 != 0) {
        err = OK;
        return -std::pow(-base, 1.0 / n);
    }
 
    err = OK;
    return std::pow(base, 1.0 / n);
}

subtract()

double mathlib::subtract	(	double	a,
		double	b )

Implementation of function subtract.

Subtract two numbers.

Parameters

a	first number
b	second number

Returns

difference of a and b

Definition at line 17 of file mathlib.cpp.

                                    {
 
    return a - b;
}