yap-6.3/packages/gecode/dev/extractor/xml/group__TaskModelFloatBranch.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
  <compounddef id="group__TaskModelFloatBranch" kind="group">
    <compoundname>TaskModelFloatBranch</compoundname>
    <title>Branching on float variables</title>
    <innerclass refid="classGecode_1_1FloatNumBranch" prot="public">Gecode::FloatNumBranch</innerclass>
    <innerclass refid="classGecode_1_1FloatAFC" prot="public">Gecode::FloatAFC</innerclass>
    <innerclass refid="classGecode_1_1FloatActivity" prot="public">Gecode::FloatActivity</innerclass>
    <innerclass refid="classGecode_1_1FloatVarBranch" prot="public">Gecode::FloatVarBranch</innerclass>
    <innerclass refid="classGecode_1_1FloatValBranch" prot="public">Gecode::FloatValBranch</innerclass>
    <innerclass refid="classGecode_1_1FloatAssign" prot="public">Gecode::FloatAssign</innerclass>
    <innergroup refid="group__TaskModelFloatBranchVar">Variable selection for float variables</innergroup>
    <innergroup refid="group__TaskModelFloatBranchVal">Value selection for float variables</innergroup>
    <innergroup refid="group__TaskModelFloatBranchAssign">Value selection for assigning float variables</innergroup>
      <sectiondef kind="typedef">
      <memberdef kind="typedef" id="group__TaskModelFloatBranch_1ga1ccd8f38e4fa45b5ce8306eaf7c63ab6" prot="public" static="no">
        <type>bool(*</type>
        <definition>typedef bool(* Gecode::FloatBranchFilter)(const Space &amp;home, FloatVar x, int i)</definition>
        <argsstring>)(const Space &amp;home, FloatVar x, int i)</argsstring>
        <name>FloatBranchFilter</name>
        <briefdescription>
<para>Branch filter function type for float variables. </para>        </briefdescription>
        <detaileddescription>
<para>The variable <emphasis>x</emphasis> is considered for selection and <emphasis>i</emphasis> refers to the variable&apos;s position in the original array passed to the brancher. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1353" column="1" bodyfile="/usr/include/gecode/float.hh" bodystart="1353" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__TaskModelFloatBranch_1ga7eb7e1523e3550892c106a552e11df68" prot="public" static="no">
        <type>double(*</type>
        <definition>typedef double(* Gecode::FloatBranchMerit)(const Space &amp;home, FloatVar x, int i)</definition>
        <argsstring>)(const Space &amp;home, FloatVar x, int i)</argsstring>
        <name>FloatBranchMerit</name>
        <briefdescription>
<para>Branch merit function type for float variables. </para>        </briefdescription>
        <detaileddescription>
<para>The function must return a merit value for the variable <emphasis>x</emphasis>. The value <emphasis>i</emphasis> refers to the variable&apos;s position in the original array passed to the brancher. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1365" column="1" bodyfile="/usr/include/gecode/float.hh" bodystart="1365" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__TaskModelFloatBranch_1ga6a41b0ae953f153a5fbfd58e15bf3415" prot="public" static="no">
        <type>FloatNumBranch(*</type>
        <definition>typedef FloatNumBranch(* Gecode::FloatBranchVal)(const Space &amp;home, FloatVar x, int i)</definition>
        <argsstring>)(const Space &amp;home, FloatVar x, int i)</argsstring>
        <name>FloatBranchVal</name>
        <briefdescription>
<para>Branch value function type for float variables. </para>        </briefdescription>
        <detaileddescription>
<para>Returns a value for the variable <emphasis>x</emphasis> that is to be used in the corresponding branch commit function. The integer <emphasis>i</emphasis> refers to the variable&apos;s position in the original array passed to the brancher. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1390" column="1" bodyfile="/usr/include/gecode/float.hh" bodystart="1390" bodyend="-1"/>
      </memberdef>
      <memberdef kind="typedef" id="group__TaskModelFloatBranch_1ga10dc42e7cfa38967f5dc51aa6c3eb1b6" prot="public" static="no">
        <type>void(*</type>
        <definition>typedef void(* Gecode::FloatBranchCommit)(Space &amp;home, unsigned int a, FloatVar x, int i, FloatNumBranch nl)</definition>
        <argsstring>)(Space &amp;home, unsigned int a, FloatVar x, int i, FloatNumBranch nl)</argsstring>
        <name>FloatBranchCommit</name>
        <briefdescription>
<para>Branch commit function type for float variables. </para>        </briefdescription>
        <detaileddescription>
<para>The function must post a constraint on the variable <emphasis>x</emphasis> which corresponds to the alternative <emphasis>a</emphasis>. The integer <emphasis>i</emphasis> refers to the variable&apos;s position in the original array passed to the brancher. The value <emphasis>nl</emphasis> is the value description computed by the corresponding branch value function. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1403" column="1" bodyfile="/usr/include/gecode/float.hh" bodystart="1403" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="group__TaskModelFloatBranch_1ga24925d545f01537b354e2460f2dc8482" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>GECODE_FLOAT_EXPORT BrancherHandle</type>
        <definition>GECODE_FLOAT_EXPORT BrancherHandle Gecode::branch</definition>
        <argsstring>(Home home, const FloatVarArgs &amp;x, FloatVarBranch vars, FloatValBranch vals, FloatBranchFilter bf=NULL, FloatVarValPrint vvp=NULL)</argsstring>
        <name>branch</name>
        <param>
          <type>Home</type>
          <declname>home</declname>
        </param>
        <param>
          <type>const FloatVarArgs &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>FloatVarBranch</type>
          <declname>vars</declname>
        </param>
        <param>
          <type>FloatValBranch</type>
          <declname>vals</declname>
        </param>
        <param>
          <type>FloatBranchFilter</type>
          <declname>bf</declname>
          <defval>NULL</defval>
        </param>
        <param>
          <type>FloatVarValPrint</type>
          <declname>vvp</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Branch over <emphasis>x</emphasis> with variable selection <emphasis>vars</emphasis> and value selection <emphasis>vals</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1754" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__TaskModelFloatBranch_1ga273b1e976614e0536edf223d5cbc867c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>GECODE_FLOAT_EXPORT BrancherHandle</type>
        <definition>GECODE_FLOAT_EXPORT BrancherHandle Gecode::branch</definition>
        <argsstring>(Home home, const FloatVarArgs &amp;x, TieBreak&lt; FloatVarBranch &gt; vars, FloatValBranch vals, FloatBranchFilter bf=NULL, FloatVarValPrint vvp=NULL)</argsstring>
        <name>branch</name>
        <param>
          <type>Home</type>
          <declname>home</declname>
        </param>
        <param>
          <type>const FloatVarArgs &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>TieBreak&lt; FloatVarBranch &gt;</type>
          <declname>vars</declname>
        </param>
        <param>
          <type>FloatValBranch</type>
          <declname>vals</declname>
        </param>
        <param>
          <type>FloatBranchFilter</type>
          <declname>bf</declname>
          <defval>NULL</defval>
        </param>
        <param>
          <type>FloatVarValPrint</type>
          <declname>vvp</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Branch over <emphasis>x</emphasis> with tie-breaking variable selection <emphasis>vars</emphasis> and value selection <emphasis>vals</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1764" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__TaskModelFloatBranch_1ga5f219e5bd6d364a07b75dde0a74e7681" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>GECODE_FLOAT_EXPORT BrancherHandle</type>
        <definition>GECODE_FLOAT_EXPORT BrancherHandle Gecode::branch</definition>
        <argsstring>(Home home, FloatVar x, FloatValBranch vals, FloatVarValPrint vvp=NULL)</argsstring>
        <name>branch</name>
        <param>
          <type>Home</type>
          <declname>home</declname>
        </param>
        <param>
          <type>FloatVar</type>
          <declname>x</declname>
        </param>
        <param>
          <type>FloatValBranch</type>
          <declname>vals</declname>
        </param>
        <param>
          <type>FloatVarValPrint</type>
          <declname>vvp</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Branch over <emphasis>x</emphasis> with value selection <emphasis>vals</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1774" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__TaskModelFloatBranch_1ga9d8be32a99c7bf82e40f571de96d31ca" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>GECODE_FLOAT_EXPORT BrancherHandle</type>
        <definition>GECODE_FLOAT_EXPORT BrancherHandle Gecode::assign</definition>
        <argsstring>(Home home, const FloatVarArgs &amp;x, FloatAssign vals, FloatBranchFilter fbf=NULL, FloatVarValPrint vvp=NULL)</argsstring>
        <name>assign</name>
        <param>
          <type>Home</type>
          <declname>home</declname>
        </param>
        <param>
          <type>const FloatVarArgs &amp;</type>
          <declname>x</declname>
        </param>
        <param>
          <type>FloatAssign</type>
          <declname>vals</declname>
        </param>
        <param>
          <type>FloatBranchFilter</type>
          <declname>fbf</declname>
          <defval>NULL</defval>
        </param>
        <param>
          <type>FloatVarValPrint</type>
          <declname>vvp</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Assign all <emphasis>x</emphasis> with value selection <emphasis>vals</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1783" column="1"/>
      </memberdef>
      <memberdef kind="function" id="group__TaskModelFloatBranch_1ga2fb55d4124a66acd7f24f7a84ae5c6c4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>GECODE_FLOAT_EXPORT BrancherHandle</type>
        <definition>GECODE_FLOAT_EXPORT BrancherHandle Gecode::assign</definition>
        <argsstring>(Home home, FloatVar x, FloatAssign vals, FloatVarValPrint vvp=NULL)</argsstring>
        <name>assign</name>
        <param>
          <type>Home</type>
          <declname>home</declname>
        </param>
        <param>
          <type>FloatVar</type>
          <declname>x</declname>
        </param>
        <param>
          <type>FloatAssign</type>
          <declname>vals</declname>
        </param>
        <param>
          <type>FloatVarValPrint</type>
          <declname>vvp</declname>
          <defval>NULL</defval>
        </param>
        <briefdescription>
<para>Assign <emphasis>x</emphasis> with value selection <emphasis>vals</emphasis>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/include/gecode/float.hh" line="1792" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>