<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPQC: sc::SCElementKNorm Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
</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>
<div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1SCElementKNorm.html">SCElementKNorm</a>
</div>
</div>
<div class="contents">
<h1>sc::SCElementKNorm Class Reference</h1><!-- doxytag: class="sc::SCElementKNorm" --><!-- doxytag: inherits="sc::SCElementOp" -->Computed k-norm of matrix.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="elemop_8h_source.html">elemop.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for sc::SCElementKNorm:</div>
<div class="dynsection">
<p><center><img src="classsc_1_1SCElementKNorm.png" usemap="#sc::SCElementKNorm_map" border="0" alt=""></center>
<map name="sc::SCElementKNorm_map">
<area href="classsc_1_1SCElementOp.html" alt="sc::SCElementOp" shape="rect" coords="0,224,130,248">
<area href="classsc_1_1SavableState.html" alt="sc::SavableState" shape="rect" coords="0,168,130,192">
<area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="0,112,130,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,130,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,130,24">
</map>
</div>
<p>
<a href="classsc_1_1SCElementKNorm-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"><a class="anchor" name="2da5e9fb031c0b4bda00785b16b1aa98"></a><!-- doxytag: member="sc::SCElementKNorm::SCElementKNorm" ref="2da5e9fb031c0b4bda00785b16b1aa98" args="(double k=2.0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCElementKNorm.html#2da5e9fb031c0b4bda00785b16b1aa98">SCElementKNorm</a> (double k=2.0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">by default compute 2-norm <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="320bfc89c7f987afd15ce84163e37543"></a><!-- doxytag: member="sc::SCElementKNorm::SCElementKNorm" ref="320bfc89c7f987afd15ce84163e37543" args="(StateIn &)" -->
</td><td class="memItemRight" valign="bottom"><b>SCElementKNorm</b> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCElementKNorm.html#1f9b5cee7f7d08230ed8796cf64c020a">save_data_state</a> (<a class="el" href="classsc_1_1StateOut.html">StateOut</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> CTOR initializes them. <a href="#1f9b5cee7f7d08230ed8796cf64c020a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCElementKNorm.html#acb952a4ceb9d94f9a9500c8631c7539">process</a> (<a class="el" href="classsc_1_1SCMatrixBlockIter.html">SCMatrixBlockIter</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the fallback routine to process blocks and is called by process_spec members that are not overridden. <a href="#acb952a4ceb9d94f9a9500c8631c7539"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCElementKNorm.html#55def528af352f87190757c92f052273">has_collect</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If duplicates of the <a class="el" href="classsc_1_1SCElementOp.html" title="Objects of class SCElementOp are used to perform operations on the elements of matrices...">SCElementOp</a> exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> reference after all of the blocks have been processed. <a href="#55def528af352f87190757c92f052273"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="98051a73801a7bcfa5fa8c9542f1dc72"></a><!-- doxytag: member="sc::SCElementKNorm::defer_collect" ref="98051a73801a7bcfa5fa8c9542f1dc72" args="(int)" -->
void </td><td class="memItemRight" valign="bottom"><b>defer_collect</b> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef224954a75d625e8e5b194fdb1cbc42"></a><!-- doxytag: member="sc::SCElementKNorm::collect" ref="ef224954a75d625e8e5b194fdb1cbc42" args="(const Ref< MessageGrp > &)" -->
void </td><td class="memItemRight" valign="bottom"><b>collect</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1MessageGrp.html">MessageGrp</a> > &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1SCElementKNorm.html#cc8f32ea3c6f1142967e2f7bfc71ebeb">collect</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1SCElementOp.html">SCElementOp</a> > &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Multithreaded use of cloneable <a class="el" href="classsc_1_1SCElementOp.html" title="Objects of class SCElementOp are used to perform operations on the elements of matrices...">SCElementOp</a> objects requires that data from cloned objects be collected. <a href="#cc8f32ea3c6f1142967e2f7bfc71ebeb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9556b439205d86ca24ac2fefd501ee59"></a><!-- doxytag: member="sc::SCElementKNorm::result" ref="9556b439205d86ca24ac2fefd501ee59" args="()" -->
double </td><td class="memItemRight" valign="bottom"><b>result</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e4cb61e6bfbbba272b42c9a498cb92c"></a><!-- doxytag: member="sc::SCElementKNorm::init" ref="7e4cb61e6bfbbba272b42c9a498cb92c" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>init</b> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Computed k-norm of matrix. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cc8f32ea3c6f1142967e2f7bfc71ebeb"></a><!-- doxytag: member="sc::SCElementKNorm::collect" ref="cc8f32ea3c6f1142967e2f7bfc71ebeb" args="(const Ref< SCElementOp > &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sc::SCElementKNorm::collect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1SCElementOp.html">SCElementOp</a> > & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Multithreaded use of cloneable <a class="el" href="classsc_1_1SCElementOp.html" title="Objects of class SCElementOp are used to perform operations on the elements of matrices...">SCElementOp</a> objects requires that data from cloned objects be collected.
<p>
The default implementation will throw an exception.
<p>Reimplemented from <a class="el" href="classsc_1_1SCElementOp.html#82e15028cda818bed43fce2d89a56838">sc::SCElementOp</a>.</p>
</div>
</div><p>
<a class="anchor" name="55def528af352f87190757c92f052273"></a><!-- doxytag: member="sc::SCElementKNorm::has_collect" ref="55def528af352f87190757c92f052273" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sc::SCElementKNorm::has_collect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If duplicates of the <a class="el" href="classsc_1_1SCElementOp.html" title="Objects of class SCElementOp are used to perform operations on the elements of matrices...">SCElementOp</a> exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a <a class="el" href="classsc_1_1MessageGrp.html" title="The MessageGrp abstract class provides a mechanism for moving data and objects between...">MessageGrp</a> reference after all of the blocks have been processed.
<p>
The default return value of has_collect is 0 and collect's default action is do nothing. If defer_collect member is called with nonzero, collect will do nothing (this is only used by the blocked matrices).
<p>Reimplemented from <a class="el" href="classsc_1_1SCElementOp.html#4725ba74d1a2b4540f1e7863e2a139f8">sc::SCElementOp</a>.</p>
</div>
</div><p>
<a class="anchor" name="acb952a4ceb9d94f9a9500c8631c7539"></a><!-- doxytag: member="sc::SCElementKNorm::process" ref="acb952a4ceb9d94f9a9500c8631c7539" args="(SCMatrixBlockIter &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sc::SCElementKNorm::process </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsc_1_1SCMatrixBlockIter.html">SCMatrixBlockIter</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is the fallback routine to process blocks and is called by process_spec members that are not overridden.
<p>
<p>Implements <a class="el" href="classsc_1_1SCElementOp.html#e7801cde57f9fc03d337bb09ce5224d8">sc::SCElementOp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1f9b5cee7f7d08230ed8796cf64c020a"></a><!-- doxytag: member="sc::SCElementKNorm::save_data_state" ref="1f9b5cee7f7d08230ed8796cf64c020a" args="(StateOut &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sc::SCElementKNorm::save_data_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsc_1_1StateOut.html">StateOut</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save the base classes (with save_data_state) and the members in the same order that the <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a> CTOR initializes them.
<p>
This must be implemented by the derived class if the class has data.
<p>Reimplemented from <a class="el" href="classsc_1_1SavableState.html#f9e0c212322d3c0f43e2dcb33e111acf">sc::SavableState</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="elemop_8h_source.html">elemop.h</a></ul>
</div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:16 2009 for <a
href="http://www.mpqc.org">MPQC</a>
2.3.1 using the documentation package <a
href="http://www.doxygen.org">Doxygen</a>
1.5.9.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
247b28499c443e092731ffba814075f2
>
files
>
677
