Arageli::residue< T, M, Config > Class Template Reference

#include <residue.hpp>

List of all members.

Public Types
typedef T	value_type
typedef M	module_type
typedef Config	config_type
Public Member Functions
	residue ()
	Creates common zero. Without module assigned.
template<typename T1>
	residue (const T1 &x)
	Creates common object of type T. Without module assigned.
template<typename T1>
	residue (const residue< T1 > &x)
	residue (const T &x, const M &m)
	residue (const char *s)
const T &	value () const
	Access to the residue value itself. Read only.
const M &	module () const
	Access to the module value. Read only.
T &	value ()
	Access to the residue value itself.
M &	module ()
	Access to the module value.
bool	is_normal () const
	Check if value is correct residue value modulo module.
void	normalize () const
	Performs normalization of residue value.
residue	operator- () const
const residue &	operator+ () const
residue &	operator++ ()
residue &	operator-- ()
residue	operator++ (int)
residue	operator-- (int)
template<typename T1, typename M1, typename Config1>
residue &	operator+= (const residue< T1, M1, Config1 > &x)
template<typename T1, typename M1, typename Config1>
residue &	operator-= (const residue< T1, M1, Config1 > &x)
template<typename T1, typename M1, typename Config1>
residue &	operator *= (const residue< T1, M1, Config1 > &x)
template<typename T1, typename M1, typename Config1>
residue &	operator/= (const residue< T1, M1, Config1 > &x)
template<typename T1, typename M1, typename Config1>
residue &	operator%= (const residue< T1, M1, Config1 > &x)
bool	operator! () const
	operator bool () const
	operator T () const

---

Detailed Description

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>
class Arageli::residue< T, M, Config >

Definition at line 61 of file residue.hpp.

---

Member Typedef Documentation

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

typedef Config Arageli::residue< T, M, Config >::config_type

Definition at line 74 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

typedef M Arageli::residue< T, M, Config >::module_type

Definition at line 73 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

typedef T Arageli::residue< T, M, Config >::value_type

Definition at line 72 of file residue.hpp.

---

Constructor & Destructor Documentation

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

Arageli::residue< T, M, Config >::residue

(

)

[inline]

Creates common zero. Without module assigned.

Definition at line 77 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1>

Arageli::residue< T, M, Config >::residue

(

const T1 &

x

)

[inline]

Creates common object of type T. Without module assigned.

Definition at line 81 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1>

Arageli::residue< T, M, Config >::residue

(

const residue< T1 > &

x

)

[inline]

Definition at line 85 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

Arageli::residue< T, M, Config >::residue	(	const T &	x,
		const M &	m
	)			[inline]

Definition at line 88 of file residue.hpp.

template<typename T, typename M, typename Config>

Arageli::residue< T, M, Config >::residue

(

const char *

s

)

Definition at line 358 of file residue.hpp.

---

Member Function Documentation

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

bool Arageli::residue< T, M, Config >::is_normal

(

)

const [inline]

Check if value is correct residue value modulo module.

Definition at line 117 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

M& Arageli::residue< T, M, Config >::module

(

)

[inline]

Access to the module value.

Definition at line 113 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

const M& Arageli::residue< T, M, Config >::module

(

)

const [inline]

Access to the module value. Read only.

Definition at line 103 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

void Arageli::residue< T, M, Config >::normalize

(

)

const [inline]

Performs normalization of residue value.

Definition at line 120 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1, typename M1, typename Config1>

residue& Arageli::residue< T, M, Config >::operator *=

(

const residue< T1, M1, Config1 > &

x

)

[inline]

Definition at line 183 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

Arageli::residue< T, M, Config >::operator bool

(

)

const [inline]

Definition at line 223 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

Arageli::residue< T, M, Config >::operator T

(

)

const [inline]

Definition at line 225 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

bool Arageli::residue< T, M, Config >::operator!

(

)

const [inline]

Definition at line 222 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1, typename M1, typename Config1>

residue& Arageli::residue< T, M, Config >::operator%=

(

const residue< T1, M1, Config1 > &

x

)

[inline]

Definition at line 219 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

const residue& Arageli::residue< T, M, Config >::operator+

(

)

const [inline]

Definition at line 129 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

residue Arageli::residue< T, M, Config >::operator++

(

int

)

[inline]

Definition at line 147 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

residue& Arageli::residue< T, M, Config >::operator++

(

)

[inline]

Definition at line 131 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1, typename M1, typename Config1>

residue& Arageli::residue< T, M, Config >::operator+=

(

const residue< T1, M1, Config1 > &

x

)

[inline]

Definition at line 151 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

residue Arageli::residue< T, M, Config >::operator-

(

)

const [inline]

Definition at line 123 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

residue Arageli::residue< T, M, Config >::operator--

(

int

)

[inline]

Definition at line 148 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

residue& Arageli::residue< T, M, Config >::operator--

(

)

[inline]

Definition at line 139 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1, typename M1, typename Config1>

residue& Arageli::residue< T, M, Config >::operator-=

(

const residue< T1, M1, Config1 > &

x

)

[inline]

Definition at line 167 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

template<typename T1, typename M1, typename Config1>

residue& Arageli::residue< T, M, Config >::operator/=

(

const residue< T1, M1, Config1 > &

x

)

[inline]

Definition at line 199 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

T& Arageli::residue< T, M, Config >::value

(

)

[inline]

Access to the residue value itself.

Definition at line 106 of file residue.hpp.

template<typename T, typename M = T, typename Config = residue_config_default<T, M>>

const T& Arageli::residue< T, M, Config >::value

(

)

const [inline]

Access to the residue value itself. Read only.

Definition at line 96 of file residue.hpp.

---

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

• residue.hpp

---