AlgebraicStructureTraits_::IntegralDivision Class Reference

#include <Concepts/AlgebraicStructureTraits--IntegralDivision.h>

Definition

AdaptableBinaryFunction providing an integral division.

Integral division (a.k.a. exact division or division without remainder) maps ring elements $(x,y)$ to ring element $z$ such that $x = yz$ if such a $z$ exists (i.e. if $x$ is divisible by $y$). Otherwise the effect of invoking this operation is undefined. Since the ring represented is an integral domain, $z$ is uniquely defined if it exists.

Refines

AdaptableBinaryFunction

See also

AlgebraicStructureTraits

AlgebraicStructureTraits_::Divides

Types
typedef unspecified_type	result_type
	Is AlgebraicStructureTraits::Type.
typedef unspecified_type	first_argument
	Is AlgebraicStructureTraits::Type.
typedef unspecified_type	second_argument
	Is AlgebraicStructureTraits::Type.

Operations
result_type	operator() (first_argument_type x, second_argument_type y)
	returns $x/y$, this is an integral division.
template<class NT1 , class NT2 >
result_type	operator() (NT1 x, NT2 y)
	This operator is defined if NT1 and NT2 are ExplicitInteroperable with coercion type AlgebraicStructureTraits::Type.

Member Typedef Documentation

first_argument

typedef unspecified_type AlgebraicStructureTraits_::IntegralDivision::first_argument

Is AlgebraicStructureTraits::Type.

result_type

typedef unspecified_type AlgebraicStructureTraits_::IntegralDivision::result_type

Is AlgebraicStructureTraits::Type.

second_argument

typedef unspecified_type AlgebraicStructureTraits_::IntegralDivision::second_argument

Is AlgebraicStructureTraits::Type.

Member Function Documentation

operator()() [1/2]

result_type AlgebraicStructureTraits_::IntegralDivision::operator()	(	first_argument_type	x,
		second_argument_type	y
	)

returns $x/y$, this is an integral division.

operator()() [2/2]

template<class NT1 , class NT2 >

result_type AlgebraicStructureTraits_::IntegralDivision::operator()	(	NT1	x,
		NT2	y
	)

This operator is defined if NT1 and NT2 are ExplicitInteroperable with coercion type AlgebraicStructureTraits::Type.