File: Maximum-and-Minimum-values.html

package info (click to toggle)
gsl-ref-html 1.16-1
links: PTS
area: non-free
in suites: jessie, jessie-kfreebsd, stretch
size: 5,816 kB
ctags: 4,130
sloc: makefile: 35
file content (134 lines) | stat: -rw-r--r-- 7,478 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections and no cover texts.  A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Maximum and Minimum values</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Maximum and Minimum values">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Maximum and Minimum values">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Statistics.html#Statistics" rel="up" title="Statistics">
<link href="Median-and-Percentiles.html#Median-and-Percentiles" rel="next" title="Median and Percentiles">
<link href="Weighted-Samples.html#Weighted-Samples" rel="previous" title="Weighted Samples">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Maximum-and-Minimum-values"></a>
<div class="header">
<p>
Next: <a href="Median-and-Percentiles.html#Median-and-Percentiles" accesskey="n" rel="next">Median and Percentiles</a>, Previous: <a href="Weighted-Samples.html#Weighted-Samples" accesskey="p" rel="previous">Weighted Samples</a>, Up: <a href="Statistics.html#Statistics" accesskey="u" rel="up">Statistics</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Maximum-and-Minimum-values-1"></a>
<h3 class="section">21.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.
</p>
<dl>
<dt><a name="index-gsl_005fstats_005fmax"></a>Function: <em>double</em> <strong>gsl_stats_max</strong> <em>(const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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 <em>x_i</em> which satisfies <em>x_i &gt;= x_j</em> for all <em>j</em>.
</p>
<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></dd></dl>

<dl>
<dt><a name="index-gsl_005fstats_005fmin"></a>Function: <em>double</em> <strong>gsl_stats_min</strong> <em>(const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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 <em>x_i</em> which satisfies <em>x_i &lt;= x_j</em> for all <em>j</em>.
</p>
<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></dd></dl>

<dl>
<dt><a name="index-gsl_005fstats_005fminmax"></a>Function: <em>void</em> <strong>gsl_stats_minmax</strong> <em>(double * <var>min</var>, double * <var>max</var>, const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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></dd></dl>

<dl>
<dt><a name="index-gsl_005fstats_005fmax_005findex"></a>Function: <em>size_t</em> <strong>gsl_stats_max_index</strong> <em>(const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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 <em>x_i</em> which satisfies 
<em>x_i &gt;= x_j</em> for all <em>j</em>.  When there are several equal maximum
elements then the first one is chosen.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fstats_005fmin_005findex"></a>Function: <em>size_t</em> <strong>gsl_stats_min_index</strong> <em>(const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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 <em>x_i</em> which satisfies
<em>x_i &gt;= x_j</em> for all <em>j</em>.  When there are several equal
minimum elements then the first one is chosen.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fstats_005fminmax_005findex"></a>Function: <em>void</em> <strong>gsl_stats_minmax_index</strong> <em>(size_t * <var>min_index</var>, size_t * <var>max_index</var>, const double <var>data</var>[], size_t <var>stride</var>, size_t <var>n</var>)</em></dt>
<dd><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></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Median-and-Percentiles.html#Median-and-Percentiles" accesskey="n" rel="next">Median and Percentiles</a>, Previous: <a href="Weighted-Samples.html#Weighted-Samples" accesskey="p" rel="previous">Weighted Samples</a>, Up: <a href="Statistics.html#Statistics" accesskey="u" rel="up">Statistics</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>