initial doc

2007-03-26 16:31:33 +00:00
parent d10a950784
commit e89fb16ade
8 changed files with 186 additions and 0 deletions
@@ -0,0 +1,28 @@
+\begin{ccRefFunctionObjectConcept}{ModularTraits::ModularImage}
+
+\ccDefinition
+
+This \ccc{AdaptableUnaryFunction} computes the modular image of the given value 
+with respect to the homomorphism $\varphi$ from the \ccc{ModularTraits::Type} into
+\ccc{ModularTraits::Modular_type}.
+
+The homomorphism preserves the mapping of \ccc{int} into both types
+, i.e., $\varphi(Type(i)) == Modular\_type(i)$.
+
+
+\ccTypes
+\ccTypedef{typedef ModularTraits::Modular_type result_type;}{}
+\ccTypedef{typedef ModularTraits::Modular_type argument_type;}{}
+
+\ccCreationVariable{fo}
+
+\ccMethod{
+result_type
+operator()(const  argument_type &);}{
+computes $\varphi(x)$.
+} 
+ 
+\ccRefines 
+\ccc{AdaptableUnaryFunction} 
+
+\end{ccRefFunctionObjectConcept}