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,42 @@
+\begin{ccRefConcept}{ModularTraits}
+
+\ccDefinition
+
+A model of \ccc{ModularTraits} is associated to specific \ccc{Type}.
+In case this type is \ccc{Modularizable}, this is indicated by the 
+
+ and reflects the properties of this type with respect 
+to the concept \ccc{Modular}.
+
+\ccTypes
+
+A model of \ccc{ModularTraits} is supposed to provide:\\
+
+\ccNestedType{Type        }{The associated type.}
+\ccGlue
+
+\ccNestedType{Is_modularizable}{ 
+  Tag indicating whether the associated type is modularizable. \\
+  This is either \ccc{CGAL::Tag_true} or \ccc{CGAL::Tag_false}. }
+
+\ccGlue
+\ccNestedType{Modular_type}{
+   The type of the modular image. \\
+   In case the type is not \ccc{Modularizable} this is undefined. 
+}
+
+\ccHeading{Functors}
+
+In case the associated type is \ccc{Modularizable} all functors are provided.\\
+In case a functor is not provided, it is set to \ccc{CGAL::Null_functor}.
+
+
+\ccNestedType{Modular_image}{A model of \ccc{ModularTraits::ModularImage} } 
+\ccGlue
+\ccNestedType{Modular_image_inverse}{A model of \ccc{ModularTraits::ModularImageInverse} } 
+
+
+\ccHasModels
+\ccRefIdfierPage{Modular_traits}\\
+
+\end{ccRefConcept}