File: Maximum-and-Minimum-values.html

package info (click to toggle)
gsl-ref-html 1.10-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,496 kB
  • ctags: 2,955
  • sloc: makefile: 33
file content (114 lines) | stat: -rw-r--r-- 6,249 bytes parent folder | download
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
<html lang="en">
<head>
<title>Maximum and Minimum values - GNU Scientific Library -- Reference Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Scientific Library -- Reference Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Statistics.html" title="Statistics">
<link rel="prev" href="Weighted-Samples.html" title="Weighted Samples">
<link rel="next" href="Median-and-Percentiles.html" title="Median and Percentiles">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License'' and ``Free Software
Needs Free Documentation'', the Front-Cover text being ``A GNU Manual'',
and with the Back-Cover Text being (a) (see below).  A copy of the
license is included in the section entitled ``GNU Free Documentation
License''.

(a) The Back-Cover Text is: ``You have freedom to copy and modify this
GNU Manual, like GNU software.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Maximum-and-Minimum-values"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Median-and-Percentiles.html">Median and Percentiles</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="Weighted-Samples.html">Weighted Samples</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Statistics.html">Statistics</a>
<hr>
</div>

<h3 class="section">20.8 Maximum and Minimum values</h3>

<p>The following functions find the maximum and minimum values of a
dataset (or their indices).  If the data contains <code>NaN</code>s then a
<code>NaN</code> will be returned, since the maximum or minimum value is
undefined.  For functions which return an index, the location of the
first <code>NaN</code> in the array is returned.

<div class="defun">
&mdash; Function: double <b>gsl_stats_max</b> (<var>const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fmax-1851"></a></var><br>
<blockquote><p>This function returns the maximum value in <var>data</var>, a dataset of
length <var>n</var> with stride <var>stride</var>.  The maximum value is defined
as the value of the element x_i which satisfies <!-- {$x_i \ge x_j$} -->
x_i &gt;= x_j for all j.

        <p>If you want instead to find the element with the largest absolute
magnitude you will need to apply <code>fabs</code> or <code>abs</code> to your data
before calling this function. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: double <b>gsl_stats_min</b> (<var>const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fmin-1852"></a></var><br>
<blockquote><p>This function returns the minimum value in <var>data</var>, a dataset of
length <var>n</var> with stride <var>stride</var>.  The minimum value is defined
as the value of the element x_i which satisfies <!-- {$x_i \le x_j$} -->
x_i &lt;= x_j for all j.

        <p>If you want instead to find the element with the smallest absolute
magnitude you will need to apply <code>fabs</code> or <code>abs</code> to your data
before calling this function. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_stats_minmax</b> (<var>double * min, double * max, const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fminmax-1853"></a></var><br>
<blockquote><p>This function finds both the minimum and maximum values <var>min</var>,
<var>max</var> in <var>data</var> in a single pass. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: size_t <b>gsl_stats_max_index</b> (<var>const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fmax_005findex-1854"></a></var><br>
<blockquote><p>This function returns the index of the maximum value in <var>data</var>, a
dataset of length <var>n</var> with stride <var>stride</var>.  The maximum value is
defined as the value of the element x_i which satisfies
<!-- {$x_i \ge x_j$} -->
x_i &gt;= x_j for all j.  When there are several equal maximum
elements then the first one is chosen. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: size_t <b>gsl_stats_min_index</b> (<var>const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fmin_005findex-1855"></a></var><br>
<blockquote><p>This function returns the index of the minimum value in <var>data</var>, a
dataset of length <var>n</var> with stride <var>stride</var>.  The minimum value
is defined as the value of the element x_i which satisfies
<!-- {$x_i \ge x_j$} -->
x_i &gt;= x_j for all j.  When there are several equal
minimum elements then the first one is chosen. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_stats_minmax_index</b> (<var>size_t * min_index, size_t * max_index, const double data</var>[]<var>, size_t stride, size_t n</var>)<var><a name="index-gsl_005fstats_005fminmax_005findex-1856"></a></var><br>
<blockquote><p>This function returns the indexes <var>min_index</var>, <var>max_index</var> of
the minimum and maximum values in <var>data</var> in a single pass. 
</p></blockquote></div>

<hr>The GNU Scientific Library - a free numerical library licensed under the GNU GPL<br>Back to the <a href="/software/gsl/">GNU Scientific Library Homepage</a></body></html>