2004-11-28 03:35:12 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" />
2010-08-09 20:07:24 +00:00
< meta name = "generator" content = "Docutils 0.7: http://docutils.sourceforge.net/" />
2004-11-28 03:35:12 +00:00
< title > The MPL Reference Manual: max</ title >
< link rel = "stylesheet" href = "../style.css" type = "text/css" />
</ head >
< body class = "docframe refmanual" >
< table class = "header" >< tr class = "header" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./min.html" class = "navigation-link" > Prev</ a > < a href = "./sizeof.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./min.html" class = "navigation-link" > Back</ a > < a href = "./sizeof.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./miscellaneous.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
< td class = "header-group page-location" >< a href = "../refmanual.html" class = "navigation-link" > Front Page</ a > / < a href = "./metafunctions.html" class = "navigation-link" > Metafunctions</ a > / < a href = "./miscellaneous.html" class = "navigation-link" > Miscellaneous</ a > / < a href = "./max.html" class = "navigation-link" > max</ a ></ td >
</ tr ></ table >< div class = "header-separator" ></ div >
< div class = "section" id = "max" >
2010-08-09 20:07:24 +00:00
< h1 >< a class = "toc-backref" href = "./miscellaneous.html#id1570" > max</ a ></ h1 >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1198" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#synopsis" name = "synopsis" > Synopsis</ a ></ h3 >
< pre class = "literal-block" >
template<
typename N1
, typename N2
>
struct < a href = "./max.html" class = "identifier" > max</ a >
{
typedef < em > unspecified</ em > type;
};
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1199" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#description" name = "description" > Description</ a ></ h3 >
< p > Returns the larger of its two arguments.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1200" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#header" name = "header" > Header</ a ></ h3 >
< pre class = "literal-block" >
#include < < a href = "../../../../boost/mpl/min_max.hpp" class = "header" > boost/mpl/min_max.hpp</ a > >
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1201" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#model-of" name = "model-of" > Model of</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< p >< a class = "reference internal" href = "./metafunction.html" > Metafunction</ a ></ p >
2004-11-28 03:35:12 +00:00
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1202" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#parameters" name = "parameters" > Parameters</ a ></ h3 >
2009-08-17 11:30:52 +00:00
< table border = "1" class = "docutils table" >
2004-11-28 03:35:12 +00:00
< colgroup >
< col width = "19%" />
< col width = "25%" />
< col width = "56%" />
</ colgroup >
< thead valign = "bottom" >
2009-08-17 11:30:52 +00:00
< tr >< th class = "head" > Parameter</ th >
< th class = "head" > Requirement</ th >
< th class = "head" > Description</ th >
2004-11-28 03:35:12 +00:00
</ tr >
</ thead >
< tbody valign = "top" >
< tr >< td >< tt class = "literal" >< span class = "pre" > N1</ span ></ tt > , < tt class = "literal" >< span class = "pre" > N2</ span ></ tt ></ td >
< td > Any type</ td >
< td > Types to compare.</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1203" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#expression-semantics" name = "expression-semantics" > Expression semantics</ a ></ h3 >
< p > For arbitrary types < tt class = "literal" >< span class = "pre" > x</ span ></ tt > and < tt class = "literal" >< span class = "pre" > y</ span ></ tt > :</ p >
< pre class = "literal-block" >
typedef < a href = "./max.html" class = "identifier" > max</ a > < x,y> ::type r;
</ pre >
2009-08-17 11:30:52 +00:00
< table class = "docutils field-list" frame = "void" rules = "none" >
2004-11-28 03:35:12 +00:00
< col class = "field-name" />
< col class = "field-body" />
< tbody valign = "top" >
2009-08-17 11:30:52 +00:00
< tr class = "field" >< th class = "field-name" > Return type:</ th >< td class = "field-body" >< p class = "first" > A type.</ p >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
2009-08-17 11:30:52 +00:00
< tr class = "field" >< th class = "field-name" > Precondition:</ th >< td class = "field-body" >< p class = "first" >< tt class = "literal" >< span class = "pre" >< a href = "./less.html" class = "identifier" > less</ a > < x,y> ::value</ span ></ tt > is a well-formed integral constant expression.</ p >
</ td >
2004-11-28 03:35:12 +00:00
</ tr >
< tr class = "field" >< th class = "field-name" > Semantics:</ th >< td class = "field-body" >< p class = "first" > Equivalent to</ p >
< pre class = "last literal-block" >
typedef < a href = "./if.html" class = "identifier" > if_</ a > < < a href = "./less.html" class = "identifier" > less</ a > < x,y> ,y,x > ::type r;
</ pre >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1204" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#complexity" name = "complexity" > Complexity</ a ></ h3 >
< p > Constant time.</ p >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1205" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#example" name = "example" > Example</ a ></ h3 >
< pre class = "literal-block" >
typedef < a href = "./fold.html" class = "identifier" > fold</ a > <
< a href = "./vector-c.html" class = "identifier" > vector_c</ a > < int,1,7,0,-2,5,-1>
, < a href = "./int.html" class = "identifier" > int_</ a > < 10>
2009-08-17 11:30:52 +00:00
, < a href = "./max.html" class = "identifier" > max</ a > < < a href = "./placeholders.html" class = "identifier" > _1</ a > ,< a href = "./placeholders.html" class = "identifier" > _2</ a > >
2004-11-28 03:35:12 +00:00
> ::type r;
< a href = "./assert.html" class = "identifier" > BOOST_MPL_ASSERT</ a > (( is_same< r, < a href = "./int.html" class = "identifier" > int_</ a > < 10> > ));
</ pre >
</ div >
2009-08-17 11:30:52 +00:00
< div class = "section" id = "id1206" >
2004-11-28 03:35:12 +00:00
< h3 >< a class = "subsection-title" href = "#see-also" name = "see-also" > See also</ a ></ h3 >
2010-08-09 20:07:24 +00:00
< p >< a class = "reference internal" href = "./metafunctions.html" > Metafunctions</ a > , < a class = "reference internal" href = "./comparisons.html" > comparison</ a > , < a class = "reference internal" href = "./min.html" > min</ a > , < a class = "reference internal" href = "./less.html" > less</ a > , < a class = "reference internal" href = "./max-element.html" > max_element</ a ></ p >
2004-11-28 03:35:12 +00:00
<!-- Metafunctions/Miscellaneous//sizeof_ |100 -->
</ div >
</ div >
< div class = "footer-separator" ></ div >
< table class = "footer" >< tr class = "footer" >< td class = "header-group navigation-bar" >< span class = "navigation-group" >< a href = "./min.html" class = "navigation-link" > Prev</ a > < a href = "./sizeof.html" class = "navigation-link" > Next</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./min.html" class = "navigation-link" > Back</ a > < a href = "./sizeof.html" class = "navigation-link" > Along</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./miscellaneous.html" class = "navigation-link" > Up</ a > < a href = "../refmanual.html" class = "navigation-link" > Home</ a ></ span >< span class = "navigation-group-separator" > | </ span >< span class = "navigation-group" >< a href = "./refmanual_toc.html" class = "navigation-link" > Full TOC</ a ></ span ></ td >
2009-08-17 11:30:52 +00:00
< td >< div class = "copyright-footer" >< div class = "copyright" > Copyright © 2001-2009 Aleksey Gurtovoy and David Abrahams</ div >
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at < a class = "reference external" href = "http://www.boost.org/LICENSE_1_0.txt" target = "_top" > http://www.boost.org/LICENSE_1_0.txt</ a > )</ div ></ td ></ tr ></ table ></ body >
2004-11-28 03:35:12 +00:00
</ html >