📄 class_u_o_f_info.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>UOFInfo 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>UOFInfo Class Reference</h1><!-- doxytag: class="UOFInfo" --><!-- doxytag: inherits="UOFId" -->Basic Info class. <a href="#_details">More...</a><p><code>#include <UOFInfo.h></code><p><p>Inheritance diagram for UOFInfo:<p><center><img src="class_u_o_f_info.png" usemap="#UOFInfo_map" border="0" alt=""></center><map name="UOFInfo_map"><area href="class_u_o_f_id.html" alt="UOFId" shape="rect" coords="0,0,59,24"></map><a href="class_u_o_f_info-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#d7bd10880e4105f61b37704e4eca04bd">UOFInfo</a> (size_t freq=1, string filename="Log.txt")</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">A constructor that builds up generates a object with initialization. <a href="#d7bd10880e4105f61b37704e4eca04bd"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#a38e1103403663e673c594b009caffb8">showEvoResultOnScreen</a> (bool seros=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the Show Optimization Result Online function. <a href="#a38e1103403663e673c594b009caffb8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#d8ace8147abbc2abaa4ca7e69eb7ba06">showEvoResultOnScreen</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the flag of Show Optimization Result Online function. <a href="#d8ace8147abbc2abaa4ca7e69eb7ba06"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#dde569964c768fd4e38677efda9a08c6">showEvoParamOnScreen</a> (bool sepos=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the Show Parameters Online function. <a href="#dde569964c768fd4e38677efda9a08c6"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#bcbf4938a399d336293ea717d09e5dc1">showEvoParamOnScreen</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the flag of Show Parameters Online function. <a href="#bcbf4938a399d336293ea717d09e5dc1"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#a1997bbda8fe4e6475b862ba9ad1e419">SetUpdateFreq</a> (size_t freq)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the frequency to display the optimization progress information. <a href="#a1997bbda8fe4e6475b862ba9ad1e419"></a><br></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_info.html#3372b08c9cfaa871276b906dae7a2239">GetUpdateFreq</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the frequency of displaying the optimization progress information. <a href="#3372b08c9cfaa871276b906dae7a2239"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#f28c9f7cb9e21434e19f20f6653034a2">SetFilename</a> (string filename)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the log file name. <a href="#f28c9f7cb9e21434e19f20f6653034a2"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#aae45cae1968f399b49319137d3ffa63">GetFilename</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the log file name. <a href="#aae45cae1968f399b49319137d3ffa63"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#c9d480882ab2ed53f9315ff7c0805406">outputResultEveryUpdate</a> (bool oreu=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the m_OutputResultFreq flag. <a href="#c9d480882ab2ed53f9315ff7c0805406"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#2b886c80ab5f3bec42ce9cef79e83752">outputResultEveryUpdate</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the m_OutputResultFreq flag. <a href="#2b886c80ab5f3bec42ce9cef79e83752"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#877d8528ee880b049a981e196d06415f">paramFilename</a> (string filename)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the file name to output parameters. <a href="#877d8528ee880b049a981e196d06415f"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#3203ad7aa90c8d1542ed685fcb0aab95">paramFilename</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file name to output parameters. <a href="#3203ad7aa90c8d1542ed685fcb0aab95"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#6da101cd04f75e5befad0af9701221a8">outputConvergenceEveryUpdate</a> (bool oreu=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the m_ConvBehavior flag. <a href="#6da101cd04f75e5befad0af9701221a8"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#3e408478663538c39c501a66b7236913">outputConvergenceEveryUpdate</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the m_ConvBehavior flag. <a href="#3e408478663538c39c501a66b7236913"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#d69f1c13a4af8dd0d15a9eb59a944d54">convergenceFilename</a> (string filename)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the file name to output convergence hebavior. <a href="#d69f1c13a4af8dd0d15a9eb59a944d54"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#74d46a2b087bb5a05e75bc144c804cf5">convergenceFilename</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file name to output convergence hebavior. <a href="#74d46a2b087bb5a05e75bc144c804cf5"></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_info.html#fedbfc66cf24de3c481893521c8b54d5">Update</a> (<a class="el" href="class_u_o_f_solver.html">UOFSolver</a> *src)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Update the information of optimization progress. <a href="#fedbfc66cf24de3c481893521c8b54d5"></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_info.html#7ddce8e0bd6f7af333862a527278ae0a">PrintInfo</a> ()=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Output the summary optimization result. <a href="#7ddce8e0bd6f7af333862a527278ae0a"></a><br></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_info.html#834839c064491719e2847a5c2126a611">GetIter</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of iteration recorded in this class. <a href="#834839c064491719e2847a5c2126a611"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#e9dda391e2c3dedde6558ffcc4071026">GetTime</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the time cost til current moment recorded in this class. <a href="#e9dda391e2c3dedde6558ffcc4071026"></a><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_info.html#9317b4085a05b5176d1b574a9c67bd8d">m_updateFreq</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#884d4c266bee3b4befb71d02a9ed4203">m_ShowEvoOnline</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#b870ea902ce48e55fa54cf7683febad9">m_ShowParamOnline</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#986055c5323c1785ae9ad35969da48cf">m_fn</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#68dcaa3eb13755d0ce65b807043168a0">m_pn</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#f1b5bae3c2d578e9d4e910d8ea344a39">m_lastpn</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#7bc62d2b23b27e31b73d3996c69a8aaa">m_OutputResultFreq</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#156ad894f0a434a2fdf02e734ab5f742">m_cn</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#426404a06da144e759e7888a970b483c">m_ConvBehavior</a></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_info.html#15feae37deef6446f42ec4c6fa2b20e2">m_itr</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#dfd95a063352bf348dfaa92e8b04c589">m_NosLog</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#801a93f825026a27865632569ec052b1">m_StartTime</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_o_f_info.html#e42e5ac9f03cbecf5184b52d062ce0e2">m_TimeElapsed</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Basic Info class. <p>Users should overrides this class if you define a new solver. This class is responsible for the information output of a solver. <p><hr><h2>Constructor & Destructor Documentation</h2><a class="anchor" name="d7bd10880e4105f61b37704e4eca04bd"></a><!-- doxytag: member="UOFInfo::UOFInfo" ref="d7bd10880e4105f61b37704e4eca04bd" args="(size_t freq=1, string filename="Log.txt")" --><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">UOFInfo::UOFInfo </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">size_t </td> <td class="mdname" nowrap> <em>freq</em> = <code>1</code>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>string </td> <td class="mdname" nowrap> <em>filename</em> = <code>"Log.txt"</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>A constructor that builds up generates a object with initialization. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>freq</em> </td><td>sets the m_updateFreq. </td></tr> <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>sets the m_fn. </td></tr> </table></dl> </td> </tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="74d46a2b087bb5a05e75bc144c804cf5"></a><!-- doxytag: member="UOFInfo::convergenceFilename" ref="74d46a2b087bb5a05e75bc144c804cf5" args="()" --><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">string UOFInfo::convergenceFilename </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Get the file name to output convergence hebavior. <p>This function returns the file name to output convergence hebavior. </td> </tr></table><a class="anchor" name="d69f1c13a4af8dd0d15a9eb59a944d54"></a><!-- doxytag: member="UOFInfo::convergenceFilename" ref="d69f1c13a4af8dd0d15a9eb59a944d54" args="(string filename)" --><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">void UOFInfo::convergenceFilename </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">string </td> <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set the file name to output convergence hebavior. <p>Once the m_ConvBehavior flag is on, The current result of each information update will be output to convergence hebavior file <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>sets the m_cn. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="aae45cae1968f399b49319137d3ffa63"></a><!-- doxytag: member="UOFInfo::GetFilename" ref="aae45cae1968f399b49319137d3ffa63" args="()" --><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">string UOFInfo::GetFilename </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Get the log file name. <p>This function returns log file name. </td> </tr></table><a class="anchor" name="834839c064491719e2847a5c2126a611"></a><!-- doxytag: member="UOFInfo::GetIter" ref="834839c064491719e2847a5c2126a611" args="()" --><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">size_t UOFInfo::GetIter </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -