blob: d6a96d76a40fb942ac56af9e54f3a28f44650883 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>rssq</title>
<style type="text/css" media="all">
@import url("scilab_code.css");
@import url("xml_code.css");
@import url("c_code.css");
@import url("style.css");
</style>
</head>
<body>
<div class="manualnavbar">
<table width="100%"><tr>
<td width="30%">
<span class="previous"><a href="rootmusic.html"><< rootmusic</a></span>
</td>
<td width="40%" class="center">
<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>
</td>
<td width="30%" class="next">
<span class="next"><a href="sampled2continuous.html">sampled2continuous >></a></span>
</td>
</tr></table>
<hr />
</div>
<span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> >> <a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a> > rssq</span>
<br /><br />
<div class="refnamediv"><h1 class="refname">rssq</h1>
<p class="refpurpose">This function calculates the square root of the sum of values of input vector IN.</p></div>
<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
<div class="synopsis"><pre><span class="default">OUT</span><span class="default">=</span><span class="functionid">rssq</span><span class="default">(</span><span class="default">IN</span><span class="default">)</span>
<span class="default">OUT</span><span class="default">=</span><span class="functionid">rssq</span><span class="default">(</span><span class="default">IN</span><span class="default">,</span><span class="default">orientation</span><span class="default">)</span></pre></div></div>
<div class="refsection"><h3 class="title">Parameters</h3>
<dl><dt><span class="term">in:</span>
<dd><p class="para">Vector or Matrix of real or complex elements.</p></dd></dt>
<dt><span class="term">orientation:</span>
<dd><p class="para">A string with possible values "r", "c" or "m" or numericals such as '1' or '2',giving the dimension along which the rssq value is to be calculated.</p></dd></dt>
<dt><span class="term">out:</span>
<dd><p class="para">A scalar with real value when input is a vector.When input is a matrix, out is the root sum squared value along the orientation specified or the default one when not specified.</p></dd></dt></dl></div>
<div class="refsection"><h3 class="title">Description</h3>
<p class="para">For vector as input, the output is real valued scalar containing the rssq value. The rssq value can be calculated by taking the square root of the squared sum of the elements.
If the input IN is a matrix, the output of function is rssq value of each column stored in a row vector OUT.</p>
<p class="para">When the elements of IN are COMPLEX, the absolute value of the element is used to calculate the output.
When the orientation is not specified for N dimensional array, it is taken as the index of the first dimension of IN that is greater than 1 and calculation is done along that orientation.</p>
<p class="para">When the orientation is specified the output is calculated along that dimension.
The orientation can be specified as 1 for rssq value of columns of matrix IN or as r.
For rssq value of rows of matrix orientation should be 2 or c.</p>
<p class="para"></p></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">rssq</span> <span class="scilabid">of</span> <span class="scilabid">a</span> <span class="scilabid">vector</span><span class="scilabspecial">:</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">2</span> <span class="scilabnumber">4</span> <span class="scilabnumber">6</span><span class="scilabopenclose">]</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span><span class="scilabid">rssq</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">is</span> <span class="scilabnumber">7.4833148</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">rssq</span> <span class="scilabid">of</span> <span class="scilabid">rows</span> <span class="scilabid">of</span> <a class="scilabcommand" href="scilab://matrix">matrix</a><span class="scilabspecial">:</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span> <span class="scilabnumber">3</span> <span class="scilabnumber">5</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span> <span class="scilabnumber">4</span> <span class="scilabnumber">6</span><span class="scilabdefault">;</span><span class="scilabnumber">7</span> <span class="scilabnumber">8</span> <span class="scilabnumber">9</span><span class="scilabopenclose">]</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span><span class="scilabid">rssq</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">should</span> <span class="scilabid">be</span> <span class="scilabid">OUT</span><span class="scilaboperator">=</span>
<span class="scilabnumber">5.9160798</span>
<span class="scilabnumber">7.4833148</span>
<span class="scilabnumber">13.928388</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">Examples</h3>
<div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">To</span> <span class="scilabid">calculate</span> <span class="scilabid">rssq</span> <span class="scilabid">of</span> <span class="scilabid">a</span> <span class="scilabid">columns</span> <span class="scilabid">of</span> <a class="scilabmacro" href="scilab://complex">complex</a> <span class="scilabstring">matrix:</span>
<span class="scilabid">IN</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">5</span><span class="scilaboperator">+</span><span class="scilabconstants">%i</span><span class="scilaboperator">*</span><span class="scilabnumber">3</span> <span class="scilabnumber">2</span><span class="scilaboperator">+</span><span class="scilabconstants">%i</span><span class="scilaboperator">*</span><span class="scilabnumber">4</span><span class="scilabdefault">;</span> <span class="scilabnumber">3</span><span class="scilaboperator">+</span><span class="scilabconstants">%i</span><span class="scilaboperator">*</span><span class="scilabnumber">6</span> <span class="scilabnumber">1</span><span class="scilaboperator">+</span><span class="scilabconstants">%i</span><span class="scilaboperator">*</span><span class="scilabnumber">2</span><span class="scilabopenclose">]</span>
<span class="scilabid">OUT</span><span class="scilaboperator">=</span><span class="scilabid">rssq</span><span class="scilabopenclose">(</span><span class="scilabid">IN</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabopenclose">)</span>
<span class="scilabid">The</span> <span class="scilabid">output</span> <span class="scilabid">should</span> <span class="scilabid">be</span> <span class="scilabid">OUT</span><span class="scilaboperator">=</span> <span class="scilabnumber">8.8881944</span> <span class="scilabnumber">5.</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>
<div class="refsection"><h3 class="title">See also</h3>
<ul class="itemizedlist"><li class="member"><a href="scilab://abs" class="link">abs</a></li>
<li class="member"><a href="scilab://mean" class="link">mean</a></li>
<li class="member"><a href="scilab://sqrt" class="link">sqrt</a></li>
<li class="member"><a href="scilab://isempty" class="link">isempty</a></li></ul></div>
<div class="refsection"><h3 class="title">Authors</h3>
<ul class="itemizedlist"><li class="member">Indira Askaukar</li></ul></div>
<div class="refsection"><h3 class="title">Bibliography</h3>
<p class="para">Matlab help document.</p></div>
<br />
<div class="manualnavbar">
<table width="100%">
<tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
<td width="30%">
<span class="previous"><a href="rootmusic.html"><< rootmusic</a></span>
</td>
<td width="40%" class="center">
<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>
</td>
<td width="30%" class="next">
<span class="next"><a href="sampled2continuous.html">sampled2continuous >></a></span>
</td>
</tr></table>
<hr />
</div>
</body>
</html>
|
