File: elementary_round.html

package info (click to toggle)
freemat 4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 174,756 kB
  • ctags: 67,023
  • sloc: cpp: 351,059; ansic: 255,892; sh: 40,590; makefile: 4,387; perl: 4,058; asm: 3,313; pascal: 2,718; fortran: 1,722; ada: 1,681; ml: 1,360; cs: 879; csh: 795; python: 430; sed: 162; lisp: 160; awk: 5
file content (69 lines) | stat: -rw-r--r-- 1,376 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML>
<HEAD>
<TITLE>ROUND Round Function
</TITLE>
</HEAD>
<BODY>
<H2>ROUND Round Function
</H2>
<P>
Section: <A HREF=sec_elementary.html> Elementary Functions </A>
<H3>Usage</H3>
Rounds an n-dimensional array to the nearest integer elementwise.
The general syntax for its use is
<PRE>
   y = round(x)
</PRE>
<P>
where <code>x</code> is a multidimensional array of numerical type.  The <code>round</code> 
function preserves the type of the argument.  So integer arguments 
are not modified, and <code>float</code> arrays return <code>float</code> arrays as 
outputs, and similarly for <code>double</code> arrays.  The <code>round</code> function 
is not defined for <code>complex</code> or <code>dcomplex</code> types.
<H3>Example</H3>
The following demonstrates the <code>round</code> function applied to various
(numerical) arguments.  For integer arguments, the round function has
no effect:
<PRE>
--&gt; round(3)

ans = 
 3 

--&gt; round(-3)

ans = 
 -3 
</PRE>
<P>
Next, we take the <code>round</code> of a floating point value:
<PRE>
--&gt; round(3.023f)

ans = 
 3 

--&gt; round(-2.341f)

ans = 
 -2 
</PRE>
<P>
Note that the return type is a <code>float</code> also.  Finally, for a <code>double</code>
type:
<PRE>
--&gt; round(4.312)

ans = 
 4 

--&gt; round(-5.32)

ans = 
 -5 
</PRE>
<P>
</BODY>
</HTML>