mirror of https://github.com/CGAL/cgal
176 lines
5.7 KiB
HTML
176 lines
5.7 KiB
HTML
<!-- Begin of cc_manual_header -->
|
|
<!-- ------------------------- -->
|
|
<!-- $Id$ -->
|
|
<!-- $Date$ -->
|
|
|
|
<!-- CC manual page automatically extracted from a TeX specification -->
|
|
<!-- in file main.html -->
|
|
<!-- by cc_extract_html, $Id$. -->
|
|
|
|
<!-- Title -->
|
|
<HEAD>
|
|
<TITLE>Vanilla: A CEP Example: </TITLE>
|
|
</HEAD>
|
|
|
|
<!-- Background layout-->
|
|
<BODY BGCOLOR="FAF8E8" TEXT="#000000">
|
|
|
|
<!-- Navigation -->
|
|
<STRONG>Navigation:</STRONG>
|
|
<A HREF="contents.html">Table of Contents</A>,
|
|
<A HREF="biblio.html">Bibliography</A>,
|
|
<A HREF="manual_index.html">Index</A>,
|
|
<A HREF="title.html">Title Page</A>
|
|
<HR>
|
|
|
|
<!-- End of cc_manual_header -->
|
|
<P>
|
|
|
|
<A NAME="Section_1"></A>
|
|
<H2>Introduction</H2>
|
|
|
|
<A NAME="sectionIntro"></A>
|
|
<P>
|
|
|
|
Flavored objects are known to be very useful in computational geometry,
|
|
especially in industrial applications.
|
|
This extension package allows one to create flavored objects and provides
|
|
an implementation of Irene's <A HREF="main.html#Enum_Flavor">Flavor</A> Enhancement algorithm
|
|
[<A HREF="biblio.html#Biblio_i-fefp-99">Ire99</A>] on these objects.
|
|
<P>
|
|
|
|
<A NAME="Section_2"></A>
|
|
<H2>Flavors and flavor enhancement</H2>
|
|
<P>
|
|
|
|
<I>#include <<A HREF="../include/CEP/Vanilla/flavor.h">CEP/Vanilla/flavor.h</A>></I>
|
|
<P>
|
|
|
|
The following enumerated type is provided in the header file <TT>flavor.h</TT>
|
|
of the Vanilla package. The functions listed here are precompiled into
|
|
the library <TT>libVanill.a</TT> provided with the package.
|
|
<P>
|
|
|
|
<TABLE BORDER=0 CELLSPACING=2 CELLPADDING=0 WIDTH=650>
|
|
<TR><TD ALIGN=LEFT VALIGN=TOP WIDTH=100% NOWRAP COLSPAN=2>
|
|
<I><NOBR>
|
|
<A NAME="Enum_Flavor"></A>
|
|
<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0><TR><TD ALIGN=LEFT VALIGN=TOP NOWRAP><I>
|
|
enum <A HREF="main.html#Enum_Flavor">Flavor</A> { </TD><TD ALIGN=LEFT VALIGN=TOP NOWRAP>
|
|
<A HREF="main.html#Enum_Flavor">VANILLA</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">CHOCOLATE_CHIP</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">MINT_CHOCOLATE_CHIP</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">CHOCOLATE</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">STRAWBERRY</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">NEAPOLITAN</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">PEACH</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">ROCKY_ROAD</A>,<BR>
|
|
|
|
<A HREF="main.html#Enum_Flavor">PISTACHIO</A>};</TD></TR></TABLE>
|
|
|
|
</I></NOBR>
|
|
</TD></TR>
|
|
<P>
|
|
|
|
</TABLE>
|
|
<P>
|
|
|
|
<TABLE BORDER=0 CELLSPACING=2 CELLPADDING=0 WIDTH=650>
|
|
<TR><TD ALIGN=LEFT VALIGN=TOP WIDTH=25% NOWRAP>
|
|
<I><NOBR>
|
|
<A NAME="Function_bool_valid_flavor6Flavor_f9;"></A>
|
|
bool
|
|
</I></NOBR>
|
|
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=75% NOWRAP COLSPAN=2>
|
|
<I><NOBR>
|
|
valid_flavor ( <A HREF="main.html#Enum_Flavor">Flavor</A> f)
|
|
</I></NOBR>
|
|
</TR><TR><TD WIDTH=25% NOWRAP></TD><TD WIDTH=25% NOWRAP></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=50%>
|
|
is <I>true</I> if <I>f</I> is a valid flavor and <I>false</I> otherwise.
|
|
</TD></TR>
|
|
<TR><TD><BR></TD></TR>
|
|
<TR><TD ALIGN=LEFT VALIGN=TOP WIDTH=25% NOWRAP>
|
|
<I><NOBR>
|
|
<A NAME="Function_Flavor_flavor_enhance6Flavor_f9;"></A>
|
|
<A HREF="main.html#Enum_Flavor">Flavor</A>
|
|
</I></NOBR>
|
|
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=75% NOWRAP COLSPAN=2>
|
|
<I><NOBR>
|
|
flavor_enhance ( <A HREF="main.html#Enum_Flavor">Flavor</A> f)
|
|
</I></NOBR>
|
|
</TR><TR><TD WIDTH=25% NOWRAP></TD><TD WIDTH=25% NOWRAP></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=50%>
|
|
implements the <A HREF="main.html#Enum_Flavor">Flavor</A> Enhancement algorithm. The return value of
|
|
the function is the enhancement of flavor <I>f</I>.
|
|
</TD></TR>
|
|
<TR><TD><BR></TD></TR>
|
|
<TR><TD ALIGN=LEFT VALIGN=TOP WIDTH=25% NOWRAP>
|
|
<I><NOBR>
|
|
<A NAME="Function_ostream__operator666ostream__os+_Flavor_f9;"></A>
|
|
ostream&
|
|
</I></NOBR>
|
|
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=75% NOWRAP COLSPAN=2>
|
|
<I><NOBR>
|
|
ostream& os << <A HREF="main.html#Enum_Flavor">Flavor</A> f
|
|
</I></NOBR>
|
|
</TR><TR><TD WIDTH=25% NOWRAP></TD><TD WIDTH=25% NOWRAP></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=50%>
|
|
output insertion operator for flavors. Inserts the string associated
|
|
with the enumeration <I>f</I> into <I>os</I> and returns the modified
|
|
stream.
|
|
</TD></TR>
|
|
<TR><TD><BR></TD></TR>
|
|
<TR><TD ALIGN=LEFT VALIGN=TOP WIDTH=25% NOWRAP>
|
|
<I><NOBR>
|
|
<A NAME="Function_istream__operator996istream__is+_Flavor__f9;"></A>
|
|
istream&
|
|
</I></NOBR>
|
|
</TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=75% NOWRAP COLSPAN=2>
|
|
<I><NOBR>
|
|
istream& is >> <A HREF="main.html#Enum_Flavor">Flavor</A>& f
|
|
</I></NOBR>
|
|
</TR><TR><TD WIDTH=25% NOWRAP></TD><TD WIDTH=25% NOWRAP></TD><TD ALIGN=LEFT VALIGN=TOP WIDTH=50%>
|
|
input extraction operator for flavors. Extracts the next string from
|
|
<I>is</I> and converts it to the corresponding <A HREF="main.html#Enum_Flavor">Flavor</A> value. If the
|
|
string does not match any of the valid flavor names, the value of <I>f</I>
|
|
does not change and the stream <I>is</I> goes into failure state.
|
|
</TD></TR>
|
|
</TABLE>
|
|
<P>
|
|
|
|
<A NAME="Section_3"></A>
|
|
<H2>Reference Pages for Vanilla CEP</H2>
|
|
<P>
|
|
|
|
<UL><LI>
|
|
<A HREF="Class_Flavored_object.html"><I>Flavored_object<O></I></A>.</UL>
|
|
<P>
|
|
|
|
<!-- Begin of cc_manual_footer -->
|
|
<!-- ------------------------- -->
|
|
<!-- $Id$ -->
|
|
<!-- $Date$ -->
|
|
|
|
<!-- Navigation -->
|
|
<HR>
|
|
<STRONG>Navigation:</STRONG>
|
|
<A HREF="main.html">Up</A>,
|
|
<A HREF="contents.html">Table of Contents</A>,
|
|
<A HREF="biblio.html">Bibliography</A>,
|
|
<A HREF="manual_index.html">Index</A>,
|
|
<A HREF="title.html">Title Page</A>
|
|
<HR>
|
|
|
|
<address>
|
|
Irene. Tue, September 14, 1999.
|
|
</address>
|
|
</BODY>
|
|
</HTML>
|
|
|
|
<!-- End of cc_manual_footer -->
|