| <!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.3"/> |
| <title>Lucene.Net: Lucene.Net.Util.RamUsageEstimator 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/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </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="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</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> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util.html">Util</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html">RamUsageEstimator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Util.RamUsageEstimator Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Estimates the size of a given Object using a given <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html" title="Returns primitive memory sizes for estimating RAM usage.">MemoryModel</a> for primitive size information. |
| <a href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#details">More...</a></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:a936b16e3dbcb451c49b8983a99dd1507"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#a936b16e3dbcb451c49b8983a99dd1507">RamUsageEstimator</a> ()</td></tr> |
| <tr class="memdesc:a936b16e3dbcb451c49b8983a99dd1507"><td class="mdescLeft"> </td><td class="mdescRight">Constructs this object with an <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_average_guess_memory_model.html" title="An average, best guess, MemoryModel that should work okay on most systems.">AverageGuessMemoryModel</a> and checkInterned = true. <a href="#a936b16e3dbcb451c49b8983a99dd1507"></a><br/></td></tr> |
| <tr class="separator:a936b16e3dbcb451c49b8983a99dd1507"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a09b4a2f60cb9977c887ecf09f42ac0b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#a09b4a2f60cb9977c887ecf09f42ac0b7">RamUsageEstimator</a> (bool checkInterned)</td></tr> |
| <tr class="separator:a09b4a2f60cb9977c887ecf09f42ac0b7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae2b5cf66a21fb43fbfadbfe6aaa8d233"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#ae2b5cf66a21fb43fbfadbfe6aaa8d233">RamUsageEstimator</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html">MemoryModel</a> memoryModel)</td></tr> |
| <tr class="separator:ae2b5cf66a21fb43fbfadbfe6aaa8d233"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9165c60e5c82b9c10cd7ba04f0982618"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#a9165c60e5c82b9c10cd7ba04f0982618">RamUsageEstimator</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html">MemoryModel</a> memoryModel, bool checkInterned)</td></tr> |
| <tr class="separator:a9165c60e5c82b9c10cd7ba04f0982618"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f115624f3be6123627f34d085cfce7f"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#a4f115624f3be6123627f34d085cfce7f">EstimateRamUsage</a> (System.Object obj)</td></tr> |
| <tr class="separator:a4f115624f3be6123627f34d085cfce7f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a3b868c414cbaab73b784b24d1f3521b9"><td class="memItemLeft" align="right" valign="top">static System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_ram_usage_estimator.html#a3b868c414cbaab73b784b24d1f3521b9">HumanReadableUnits</a> (long bytes, System.IFormatProvider df)</td></tr> |
| <tr class="memdesc:a3b868c414cbaab73b784b24d1f3521b9"><td class="mdescLeft"> </td><td class="mdescRight">Return good default units based on byte size. <a href="#a3b868c414cbaab73b784b24d1f3521b9"></a><br/></td></tr> |
| <tr class="separator:a3b868c414cbaab73b784b24d1f3521b9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Estimates the size of a given Object using a given <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html" title="Returns primitive memory sizes for estimating RAM usage.">MemoryModel</a> for primitive size information. </p> |
| <p>Resource Usage:</p> |
| <p>Internally uses a Map to temporally hold a reference to every object seen.</p> |
| <p>If checkIntered, all Strings checked will be interned, but those that were not already interned will be released for GC when the estimate is complete. </p> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00036">36</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a936b16e3dbcb451c49b8983a99dd1507"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Util.RamUsageEstimator.RamUsageEstimator </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs this object with an <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_average_guess_memory_model.html" title="An average, best guess, MemoryModel that should work okay on most systems.">AverageGuessMemoryModel</a> and checkInterned = true. </p> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00051">51</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a09b4a2f60cb9977c887ecf09f42ac0b7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Util.RamUsageEstimator.RamUsageEstimator </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>checkInterned</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">checkInterned</td><td>check if Strings are interned and don't add to size if they are. Defaults to true but if you know the objects you are checking won't likely contain many interned Strings, it will be faster to turn off intern checking. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00060">60</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae2b5cf66a21fb43fbfadbfe6aaa8d233"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Util.RamUsageEstimator.RamUsageEstimator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html">MemoryModel</a> </td> |
| <td class="paramname"><em>memoryModel</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memoryModel</td><td><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html" title="Returns primitive memory sizes for estimating RAM usage.">MemoryModel</a> to use for primitive object sizes. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00066">66</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9165c60e5c82b9c10cd7ba04f0982618"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Util.RamUsageEstimator.RamUsageEstimator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html">MemoryModel</a> </td> |
| <td class="paramname"><em>memoryModel</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>checkInterned</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">memoryModel</td><td><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_memory_model.html" title="Returns primitive memory sizes for estimating RAM usage.">MemoryModel</a> to use for primitive object sizes. </td></tr> |
| <tr><td class="paramname">checkInterned</td><td>check if Strings are interned and don't add to size if they are. Defaults to true but if you know the objects you are checking won't likely contain many interned Strings, it will be faster to turn off intern checking. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00077">77</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a4f115624f3be6123627f34d085cfce7f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Lucene.Net.Util.RamUsageEstimator.EstimateRamUsage </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </td> |
| <td class="paramname"><em>obj</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00089">89</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3b868c414cbaab73b784b24d1f3521b9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static System.String Lucene.Net.Util.RamUsageEstimator.HumanReadableUnits </td> |
| <td>(</td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>bytes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IFormatProvider </td> |
| <td class="paramname"><em>df</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return good default units based on byte size.</p> |
| |
| <p>Definition at line <a class="el" href="_ram_usage_estimator_8cs_source.html#l00196">196</a> of file <a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Util/<a class="el" href="_ram_usage_estimator_8cs_source.html">RamUsageEstimator.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
