lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-03-30 23:57:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
2d5c650ea1adf3b22657713582b3c3e736030995
opennurbs/6/class_o_n___sum.html
Bozo 2d5c650ea1 Publish! 
Generated from TESTING
2018-01-26 12:35:52 +00:00

289 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_Sum Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_o_n___sum-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_Sum Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="opennurbs__math_8h_source.html">opennurbs_math.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af1faca3cc368e02733d988a04e434eed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#af1faca3cc368e02733d988a04e434eed">ON_Sum</a> ()</td></tr>
<tr class="separator:af1faca3cc368e02733d988a04e434eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74fa9d75aac2ed90b1a4dadba6d95961"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a74fa9d75aac2ed90b1a4dadba6d95961">Begin</a> (double starting_value=0.0)</td></tr>
<tr class="separator:a74fa9d75aac2ed90b1a4dadba6d95961"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a674f6ee8ae2c4d5a323eebed3173684d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a674f6ee8ae2c4d5a323eebed3173684d">operator+=</a> (double x)</td></tr>
<tr class="separator:a674f6ee8ae2c4d5a323eebed3173684d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bec3f2a615e1f83b8f852245410ad34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a1bec3f2a615e1f83b8f852245410ad34">operator-=</a> (double x)</td></tr>
<tr class="separator:a1bec3f2a615e1f83b8f852245410ad34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a027a89cec6901446853493ae7ea4827a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a027a89cec6901446853493ae7ea4827a">operator=</a> (double x)</td></tr>
<tr class="separator:a027a89cec6901446853493ae7ea4827a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a300264a1c6ecdb0d51464b808706b730"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a300264a1c6ecdb0d51464b808706b730">Plus</a> (double x)</td></tr>
<tr class="separator:a300264a1c6ecdb0d51464b808706b730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa9261c9ff6d341f5e4d5f380196b82a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#afa9261c9ff6d341f5e4d5f380196b82a">Plus</a> (double x, double dx)</td></tr>
<tr class="separator:afa9261c9ff6d341f5e4d5f380196b82a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a487319cab02c7cbe906ed45a3822b3a2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#a487319cab02c7cbe906ed45a3822b3a2">SummandCount</a> () const</td></tr>
<tr class="separator:a487319cab02c7cbe906ed45a3822b3a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2ebb80f6b96309951a6ba769bac33f0"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_o_n___sum.html#ab2ebb80f6b96309951a6ba769bac33f0">Total</a> (double *error_estimate=nullptr)</td></tr>
<tr class="separator:ab2ebb80f6b96309951a6ba769bac33f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Description: Class for carefully adding long list of numbers. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af1faca3cc368e02733d988a04e434eed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1faca3cc368e02733d988a04e434eed">&#9670;&nbsp;</a></span>ON_Sum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_Sum::ON_Sum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Creates a sum that is ready to be used. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a74fa9d75aac2ed90b1a4dadba6d95961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74fa9d75aac2ed90b1a4dadba6d95961">&#9670;&nbsp;</a></span>Begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::Begin </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>starting_value</em> = <code>0.0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: If a sum is being used more than once, call <a class="el" href="class_o_n___sum.html#a74fa9d75aac2ed90b1a4dadba6d95961">Begin()</a> before starting each sum. Parameters: starting_value - [in] Initial value of sum. </p>
</div>
</div>
<a id="a674f6ee8ae2c4d5a323eebed3173684d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a674f6ee8ae2c4d5a323eebed3173684d">&#9670;&nbsp;</a></span>operator+=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::operator+= </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Calls ON_Sum::Plus(x); </p>
</div>
</div>
<a id="a1bec3f2a615e1f83b8f852245410ad34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bec3f2a615e1f83b8f852245410ad34">&#9670;&nbsp;</a></span>operator-=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::operator-= </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Calls <a class="el" href="class_o_n___sum.html#a300264a1c6ecdb0d51464b808706b730">ON_Sum::Plus</a>(-x); </p>
</div>
</div>
<a id="a027a89cec6901446853493ae7ea4827a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027a89cec6901446853493ae7ea4827a">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::operator= </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Calls ON_Sum::Begin(x) </p>
</div>
</div>
<a id="a300264a1c6ecdb0d51464b808706b730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a300264a1c6ecdb0d51464b808706b730">&#9670;&nbsp;</a></span>Plus() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::Plus </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Add x to the current sum. Parameters: x - [in] value to add to the current sum. </p>
</div>
</div>
<a id="afa9261c9ff6d341f5e4d5f380196b82a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa9261c9ff6d341f5e4d5f380196b82a">&#9670;&nbsp;</a></span>Plus() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ON_Sum::Plus </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>dx</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Add x to the current sum. Parameters: x - [in] value to add to the current sum. dx - [in] symmetric uncertainty in x. (true value is in the range x-dx to x+dx </p>
</div>
</div>
<a id="a487319cab02c7cbe906ed45a3822b3a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a487319cab02c7cbe906ed45a3822b3a2">&#9670;&nbsp;</a></span>SummandCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ON_Sum::SummandCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns: Number of summands. </p>
</div>
</div>
<a id="ab2ebb80f6b96309951a6ba769bac33f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2ebb80f6b96309951a6ba769bac33f0">&#9670;&nbsp;</a></span>Total()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ON_Sum::Total </td>
<td>(</td>
<td class="paramtype">double *&#160;</td>
<td class="paramname"><em>error_estimate</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Calculates the total sum. <br />
Parameters: error_estimate - [out] if not nullptr, the returned value of error_estimate is an estimate of the error in the sum. Returns: Total of the sum. Remarks: You can get subtotals by mixing calls to <a class="el" href="class_o_n___sum.html#a300264a1c6ecdb0d51464b808706b730">Plus()</a> and <a class="el" href="class_o_n___sum.html#ab2ebb80f6b96309951a6ba769bac33f0">Total()</a>. In delicate sums, some precision may be lost in the final total if you call <a class="el" href="class_o_n___sum.html#ab2ebb80f6b96309951a6ba769bac33f0">Total()</a> to calculate subtotals. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 25 2018 17:01:11 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink