📄 class_u_o_f_problem.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>UOFProblem Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.5 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li id="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><h1>UOFProblem Class Reference</h1><!-- doxytag: class="UOFProblem" --><!-- doxytag: inherits="UOFId" -->Basic Problem class. <a href="#_details">More...</a><p><code>#include <UOFProblem.h></code><p><p>Inheritance diagram for UOFProblem:<p><center><img src="class_u_o_f_problem.png" usemap="#UOFProblem_map" border="0" alt=""></center><map name="UOFProblem_map"><area href="class_u_o_f_id.html" alt="UOFId" shape="rect" coords="0,0,84,24"></map><a href="class_u_o_f_problem-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#375d2d5242da314eeac6ec5b0f8d2459">GetResult</a> (void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the emulation result to the callee. <a href="#375d2d5242da314eeac6ec5b0f8d2459"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#984bdcc1315e366295cce595c852be39">GetResult</a> (void *, void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the emulation results to the callee. <a href="#984bdcc1315e366295cce595c852be39"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#c968336bad59981aa4e9d73eb50d4382">GetJacobianResult</a> (void *, void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the emulation results to the callee. <a href="#c968336bad59981aa4e9d73eb50d4382"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#66bd5627a78813f289970d654aac70a7">GetExternalData</a> (void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the specific data to the callee. <a href="#66bd5627a78813f289970d654aac70a7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#71335155b3222529de925a986e3518ad">PostProcess</a> (void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Performs the post process once the optimization procedure is finished. <a href="#71335155b3222529de925a986e3518ad"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="253c282a9c66eb77f6e9aff7614f2054"></a><!-- doxytag: member="UOFProblem::GetProblemDim" ref="253c282a9c66eb77f6e9aff7614f2054" args="()" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#253c282a9c66eb77f6e9aff7614f2054">GetProblemDim</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the dimension of this problem. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#981f55d6a9ddcd6d0a6485cbc97bfcda">SetConstraint</a> (void *)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">This function sets the constraint of each parameter. <a href="#981f55d6a9ddcd6d0a6485cbc97bfcda"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2972023c9e7c224976c7c8d9de459395"></a><!-- doxytag: member="UOFProblem::constraint" ref="2972023c9e7c224976c7c8d9de459395" args="(int i)" --><a class="el" href="class_u_o_f_constraint.html">UOFConstraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#2972023c9e7c224976c7c8d9de459395">constraint</a> (int i)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the constraint of a parameter. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b077a2891f2e96d86217592f04eecbd5"></a><!-- doxytag: member="UOFProblem::GetRandom" ref="b077a2891f2e96d86217592f04eecbd5" args="(int i)" -->double </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#b077a2891f2e96d86217592f04eecbd5">GetRandom</a> (int i)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a random value under the constraint of a parameter. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52ce894490c58512f97af15f66493470"></a><!-- doxytag: member="UOFProblem::SetFixParam" ref="52ce894490c58512f97af15f66493470" args="(vector< int > list)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#52ce894490c58512f97af15f66493470">SetFixParam</a> (vector< int > list)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the parameters in list from the parameters to be optimized. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="406a19781ea5f4e3dd7d0685e5b77c98"></a><!-- doxytag: member="UOFProblem::SetFixParam" ref="406a19781ea5f4e3dd7d0685e5b77c98" args="(vector< string > list)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#406a19781ea5f4e3dd7d0685e5b77c98">SetFixParam</a> (vector< string > list)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the parameters in list from the parameters to be optimized. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23c76d459ad8f16f70f8dcf4ed7783fc"></a><!-- doxytag: member="UOFProblem::SetExtrParam" ref="23c76d459ad8f16f70f8dcf4ed7783fc" args="(vector< int > list)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#23c76d459ad8f16f70f8dcf4ed7783fc">SetExtrParam</a> (vector< int > list)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set only the parameters in list will be optimized. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bf4e13432d9f291c9035d9842d2350c"></a><!-- doxytag: member="UOFProblem::SetExtrParam" ref="1bf4e13432d9f291c9035d9842d2350c" args="(vector< string > list)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#1bf4e13432d9f291c9035d9842d2350c">SetExtrParam</a> (vector< string > list)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set only the parameters in list will be optimized. <br></td></tr><tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">vector< <a class="el" href="class_u_o_f_constraint.html">UOFConstraint</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#6251f38116b78105cfda9f2bf478915d">m_Const</a></td></tr><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb2b9466d3cf271d4c6b5342e7153302"></a><!-- doxytag: member="UOFProblem::FindConstraint" ref="bb2b9466d3cf271d4c6b5342e7153302" args="(string name, vector< UOFConstraint > cons)" --><a class="el" href="class_u_o_f_constraint.html">UOFConstraint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#bb2b9466d3cf271d4c6b5342e7153302">FindConstraint</a> (string name, vector< <a class="el" href="class_u_o_f_constraint.html">UOFConstraint</a> > cons)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Find the constraint from a pool. <br></td></tr><tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#5031e2753b339eb77ebbf0d1c1d5497e">m_problemDim</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">vector< <a class="el" href="class_u_o_f_constraint.html">UOFConstraint</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_problem.html#13c548aa84ff0163d87846fd850c1b08">m_DefConst</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Basic Problem class. <p>Users should overrides this class if you define a new problem <p><hr><h2>Member Function Documentation</h2><a class="anchor" name="66bd5627a78813f289970d654aac70a7"></a><!-- doxytag: member="UOFProblem::GetExternalData" ref="66bd5627a78813f289970d654aac70a7" args="(void *)=0" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual void UOFProblem::GetExternalData </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void * </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the specific data to the callee. <p>This is an abstract function, User must override this function to work. This function should be called if the callee needs the more data than just result. </td> </tr></table><a class="anchor" name="c968336bad59981aa4e9d73eb50d4382"></a><!-- doxytag: member="UOFProblem::GetJacobianResult" ref="c968336bad59981aa4e9d73eb50d4382" args="(void *, void *)=0" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual void UOFProblem::GetJacobianResult </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void * </td> <td class="mdname" nowrap>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [pure virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Returns the emulation results to the callee. <p>This is an abstract function, User must override this function to work. This function should be called if the callee needs the derivatives of the result. </td> </tr></table><a class="anchor" name="984bdcc1315e366295cce595c852be39"></a><!-- doxytag: member="UOFProblem::GetResult" ref="984bdcc1315e366295cce595c852be39" args="(void *, void *)=0" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual void UOFProblem::GetResult </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void * </td> <td class="mdname" nowrap>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap></td> </tr> <tr> <td class="md"></td> <td class="md">) </td>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -