CGAL users discussion list

["Laurent Rineau (GeometryFactory)" <>]

On Monday 28 September 2009 10:33:57 Sybren A. Stüvel wrote:
> On Mon, Sep 28, 2009 at 09:39:24AM +0200, Monique Teillaud wrote:
> > In fact it _is_ documented
> > http://www.cgal.org/Manual/last/doc_html/cgal_manual/Triangulation_3_ref/
> >Class_Triangulation_3.html#Cross_link_anchor_1185 scroll to the bottom of
> > the page
> > And there is a similar documentation in
> > Triangulation_data_structure_3  for the combinatorial part.
> 
> The documentation is there indeed. However, you have to read it really
> well to know that "the number of finite vertices" may imply that the
> infinite vertex is also referred to. It doesn't mention that the
> vertex at index 0 is the infinite vertex. So it's documented, but not
> completely.
> 
> It's not a big deal when you can subscribe to the mailing list, ask a
> question about this, and get an answer, all within five minutes.
> Thanks again for your quick help.

The CGAL documentation is a kind of contract with users that the 
specifications will not be changed (but if there are good reasons). As is, 
the 
documentation of operator<< is not precise enough so that you can really rely 
on it. The output operator could be changed in future releases of CGAL 
without 
any mention in the release notes.

But be reassured, that is not our intend, for the moment. I think there is 
not 
reason that operator<< could change in near future.

-- 
Laurent Rineau, PhD
Release Manager of the CGAL Project
http://www.cgal.org/
R&D Engineer at GeometryFactory
http://www.geometryfactory.com/