mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-05-08 03:56:54 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #3638 from quickfur/min_doc

Browse source 
[dox] Improve docs for std.algorithm.comparison.min
This commit is contained in:
Robert Schadek 2015-09-10 12:22:41 +02:00
commit e5c3d756eb
1 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
std/algorithm/comparison.d
View file

@ -1324,7 +1324,11 @@ private template MinType(T...)
// min // min
/** /**
Returns the minimum of the passed-in values. Iterates the passed arguments and returns the minimum value.
Params: args = The values to select the minimum from. At least two arguments
must be passed, and they must be comparable with `<`.
Returns: The minimum of the passed-in values.
*/ */
MinType!T min(T...)(T args) MinType!T min(T...)(T args)
if (T.length >= 2) if (T.length >= 2)
@ -1353,10 +1357,9 @@ MinType!T min(T...)(T args)
return cast(typeof(return)) (chooseA ? a : b); return cast(typeof(return)) (chooseA ? a : b);
} }
///
@safe unittest @safe unittest
{ {
debug(std_algorithm) scope(success)
writeln("unittest @", __FILE__, ":", __LINE__, " done.");
int a = 5; int a = 5;
short b = 6; short b = 6;
double c = 2; double c = 2;
@ -1366,13 +1369,15 @@ MinType!T min(T...)(T args)
auto e = min(a, b, c); auto e = min(a, b, c);
static assert(is(typeof(e) == double)); static assert(is(typeof(e) == double));
assert(e == 2); assert(e == 2);
// mixed signedness test
// With arguments of mixed signedness, the return type is the one that can
// store the lowest values.
a = -10; a = -10;
uint f = 10; uint f = 10;
static assert(is(typeof(min(a, f)) == int)); static assert(is(typeof(min(a, f)) == int));
assert(min(a, f) == -10); assert(min(a, f) == -10);
//Test user-defined types // User-defined types that support comparison with < are supported.
import std.datetime; import std.datetime;
assert(min(Date(2012, 12, 21), Date(1982, 1, 4)) == Date(1982, 1, 4)); assert(min(Date(2012, 12, 21), Date(1982, 1, 4)) == Date(1982, 1, 4));
assert(min(Date(1982, 1, 4), Date(2012, 12, 21)) == Date(1982, 1, 4)); assert(min(Date(1982, 1, 4), Date(2012, 12, 21)) == Date(1982, 1, 4));