"Fossies" - the Fresh Open Source Software Archive

Member "doc_html/Kernel_23/xml/classKernel_1_1CompareSquaredDistance__3.xml" (8 Nov 2019, 4545 Bytes) of package /linux/misc/CGAL-5.0-doc_html.tar.xz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "classKernel_1_1CompareSquaredDistance__3.xml": 4.12.1-doc_html_vs_4.13-doc_html.

    1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
    2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.13">
    3   <compounddef id="classKernel_1_1CompareSquaredDistance__3" kind="class" language="C++" prot="public">
    4     <compoundname>Kernel::CompareSquaredDistance_3</compoundname>
    5     <includes local="no">Concepts/FunctionObjectConcepts.h</includes>
    6       <sectiondef kind="user-defined">
    7       <header>Operations</header>
    8       <description><para>A model of this concept must provide: </para></description>
    9       <memberdef kind="function" id="classKernel_1_1CompareSquaredDistance__3_1a9d18108278fde42d2a2dd8ddf0382c11" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
   10         <type><ref refid="classKernel_1affdddb2220b43be2336136caf7162362" kindref="member">Comparison_result</ref></type>
   11         <definition>Comparison_result Kernel::CompareSquaredDistance_3::operator()</definition>
   12         <argsstring>(const Type1 &amp;obj1, const Type2 &amp;obj2, const Kernel::FT &amp;d2)</argsstring>
   13         <name>operator()</name>
   14         <param>
   15           <type>const Type1 &amp;</type>
   16           <declname>obj1</declname>
   17         </param>
   18         <param>
   19           <type>const Type2 &amp;</type>
   20           <declname>obj2</declname>
   21         </param>
   22         <param>
   23           <type>const <ref refid="classKernel_1a55e83f5a9f8ca43588b02ae8256a8fbd" kindref="member">Kernel::FT</ref> &amp;</type>
   24           <declname>d2</declname>
   25         </param>
   26         <briefdescription>
   27 <para>compares the squared distance between the two geometrical objects <computeroutput>obj1</computeroutput> and <computeroutput>obj2</computeroutput> to the value <computeroutput>d2</computeroutput>, for all pairs <computeroutput>Type1</computeroutput> and <computeroutput>Type2</computeroutput>, where the types <computeroutput>Type1</computeroutput> and <computeroutput>Type2</computeroutput> can be any of the following: </para>        </briefdescription>
   28         <detaileddescription>
   29 <para><itemizedlist>
   30 <listitem><para><computeroutput><ref refid="classKernel_1_1Point__3" kindref="compound">Kernel::Point_3</ref></computeroutput></para></listitem><listitem><para><computeroutput><ref refid="classKernel_1_1Line__3" kindref="compound">Kernel::Line_3</ref></computeroutput></para></listitem><listitem><para><computeroutput><ref refid="classKernel_1_1Ray__3" kindref="compound">Kernel::Ray_3</ref></computeroutput></para></listitem><listitem><para><computeroutput><ref refid="classKernel_1_1Segment__3" kindref="compound">Kernel::Segment_3</ref></computeroutput></para></listitem><listitem><para><computeroutput><ref refid="classKernel_1_1Plane__3" kindref="compound">Kernel::Plane_3</ref></computeroutput> </para></listitem></itemizedlist>
   31 </para>        </detaileddescription>
   32         <inbodydescription>
   33         </inbodydescription>
   34         <location file="Concepts/FunctionObjectConcepts.h" line="1114" column="1"/>
   35       </memberdef>
   36       </sectiondef>
   37     <briefdescription>
   38     </briefdescription>
   39     <detaileddescription>
   40 <para> <xrefsect id="refines_1_refines000028"><xreftitle>Refines</xreftitle><xrefdescription><para><computeroutput><ref refid="classAdaptableFunctor" kindref="compound" external="/home/cgal-testsuite/cgal_doc_build/CGAL-5.0-I-190/doc/scripts/build_doc/doc_tags/Manual.tag">AdaptableFunctor</ref></computeroutput> (with three arguments) </para></xrefdescription></xrefsect></para><para><simplesect kind="see"><para><computeroutput><ref refid="classKernel_1_1CompareDistance__3" kindref="compound">Kernel::CompareDistance_3</ref></computeroutput> </para></simplesect>
   41 <simplesect kind="see"><para><computeroutput><ref refid="group__compare__distance__to__point__grp" kindref="compound">CGAL::compare_distance_to_point()</ref></computeroutput> </para></simplesect>
   42 <simplesect kind="see"><para><computeroutput><ref refid="group__compare__squared__distance__grp" kindref="compound">CGAL::compare_squared_distance()</ref></computeroutput> </para></simplesect>
   43 </para>    </detaileddescription>
   44     <location file="Concepts/FunctionObjectConcepts.h" line="1097" column="1" bodyfile="Concepts/FunctionObjectConcepts.h" bodystart="1097" bodyend="1120"/>
   45     <listofallmembers>
   46       <member refid="classKernel_1_1CompareSquaredDistance__3_1a9d18108278fde42d2a2dd8ddf0382c11" prot="public" virt="non-virtual"><scope>Kernel::CompareSquaredDistance_3</scope><name>operator()</name></member>
   47     </listofallmembers>
   48   </compounddef>
   49 </doxygen>