diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-05-18 15:02:36 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-05-18 15:02:36 +0000 |
commit | 8480bcc8d5c72b61055cfa98e80f37fd62ae7ad4 (patch) | |
tree | f404254dbcee2a59866dbb3f7baab4df8e4b23ce /enum.c | |
parent | 32378c5abea38a8278dae28eae9abcd547ac8a95 (diff) |
Merge -r16241:16456 from ruby_1_8.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8_7@16458 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'enum.c')
-rw-r--r-- | enum.c | 246 |
1 files changed, 119 insertions, 127 deletions
@@ -84,18 +84,18 @@ grep_iter_i(i, arg) * call-seq: * enum.grep(pattern) => array * enum.grep(pattern) {| obj | block } => array - * + * * Returns an array of every element in <i>enum</i> for which * <code>Pattern === element</code>. If the optional <em>block</em> is * supplied, each matching element is passed to it, and the block's * result is stored in the output array. - * + * * (1..100).grep 38..44 #=> [38, 39, 40, 41, 42, 43, 44] * c = IO.constants * c.grep(/SEEK/) #=> ["SEEK_END", "SEEK_SET", "SEEK_CUR"] * res = c.grep(/SEEK/) {|v| IO.const_get(v) } * res #=> [2, 0, 1] - * + * */ static VALUE @@ -109,7 +109,7 @@ enum_grep(obj, pat) arg[1] = ary; rb_iterate(rb_each, obj, rb_block_given_p() ? grep_iter_i : grep_i, (VALUE)arg); - + return ary; } @@ -139,14 +139,14 @@ count_iter_i(i, n) * call-seq: * enum.count(item) => int * enum.count {| obj | block } => int - * + * * Returns the number of items in <i>enum</i> for which equals to <i>item</i>. * If a block is given, counts the number of elements yielding a true value. - * + * * ary = [1, 2, 4, 2] * ary.count(2) # => 2 * ary.count{|x|x%2==0} # => 3 - * + * */ static VALUE @@ -198,15 +198,15 @@ find_i(i, memo) * call-seq: * enum.detect(ifnone = nil) {| obj | block } => obj or nil * enum.find(ifnone = nil) {| obj | block } => obj or nil - * + * * Passes each entry in <i>enum</i> to <em>block</em>. Returns the * first for which <em>block</em> is not <code>false</code>. If no * object matches, calls <i>ifnone</i> and returns its result when it * is specified, or returns <code>nil</code> - * + * * (1..10).detect {|i| i % 5 == 0 and i % 7 == 0 } #=> nil * (1..100).detect {|i| i % 5 == 0 and i % 7 == 0 } #=> 35 - * + * */ static VALUE @@ -266,16 +266,16 @@ find_index_iter_i(i, memop) * call-seq: * enum.find_index(value) => int or nil * enum.find_index {| obj | block } => int or nil - * + * * Compares each entry in <i>enum</i> with <em>value</em> or passes * to <em>block</em>. Returns the index for the first for which the * evaluated value is non-false. If no object matches, returns * <code>nil</code> - * + * * (1..10).find_index {|i| i % 5 == 0 and i % 7 == 0 } #=> nil * (1..100).find_index {|i| i % 5 == 0 and i % 7 == 0 } #=> 34 * (1..100).find_index(50) #=> 49 - * + * */ static VALUE @@ -319,13 +319,13 @@ find_all_i(i, ary) * call-seq: * enum.find_all {| obj | block } => array * enum.select {| obj | block } => array - * + * * Returns an array containing all elements of <i>enum</i> for which * <em>block</em> is not <code>false</code> (see also * <code>Enumerable#reject</code>). - * + * * (1..10).find_all {|i| i % 3 == 0 } #=> [3, 6, 9] - * + * */ static VALUE @@ -353,12 +353,12 @@ reject_i(i, ary) /* * call-seq: * enum.reject {| obj | block } => array - * + * * Returns an array for all elements of <i>enum</i> for which * <em>block</em> is false (see also <code>Enumerable#find_all</code>). - * + * * (1..10).reject {|i| i % 3 == 0 } #=> [1, 2, 4, 5, 7, 8, 10] - * + * */ static VALUE @@ -366,7 +366,7 @@ enum_reject(obj) VALUE obj; { VALUE ary = rb_ary_new(); - + RETURN_ENUMERATOR(obj, 0, 0); rb_iterate(rb_each, obj, reject_i, ary); @@ -395,13 +395,13 @@ collect_all(i, ary) * call-seq: * enum.collect {| obj | block } => array * enum.map {| obj | block } => array - * + * * Returns a new array with the results of running <em>block</em> once * for every element in <i>enum</i>. - * + * * (1..4).collect {|i| i*i } #=> [1, 4, 9, 16] * (1..4).collect { "cat" } #=> ["cat", "cat", "cat", "cat"] - * + * */ static VALUE @@ -419,9 +419,9 @@ enum_collect(obj) * call-seq: * enum.to_a => array * enum.entries => array - * + * * Returns an array containing the items in <i>enum</i>. - * + * * (1..7).to_a #=> [1, 2, 3, 4, 5, 6, 7] * { 'a'=>1, 'b'=>2, 'c'=>3 }.to_a #=> [["a", 1], ["b", 2], ["c", 3]] */ @@ -480,7 +480,7 @@ inject_op_i(i, p) * enum.reduce(sym) => obj * enum.reduce(initial) {| memo, obj | block } => obj * enum.reduce {| memo, obj | block } => obj - * + * * Combines all elements of <i>enum</i> by applying a binary * operation, specified by a block or a symbol that names a * method or operator. @@ -489,7 +489,7 @@ inject_op_i(i, p) * the block is passed an accumulator value (<i>memo</i>) and the element. * If you specify a symbol instead, then each element in the collection * will be passed to the named method of <i>memo</i>. - * In either case, the result becomes the new value for <i>memo</i>. + * In either case, the result becomes the new value for <i>memo</i>. * At the end of the iteration, the final value of <i>memo</i> is the * return value fo the method. * @@ -497,7 +497,7 @@ inject_op_i(i, p) * then uses the first element of collection is used as the initial value * of <i>memo</i>. * - * Examples: + * Examples: * * # Sum some numbers * (5..10).reduce(:+) #=> 45 @@ -512,7 +512,7 @@ inject_op_i(i, p) * memo.length > word.length ? memo : word * end * longest #=> "sheep" - * + * */ static VALUE enum_inject(argc, argv, obj) @@ -564,13 +564,13 @@ partition_i(i, ary) /* * call-seq: * enum.partition {| obj | block } => [ true_array, false_array ] - * + * * Returns two arrays, the first containing the elements of * <i>enum</i> for which the block evaluates to true, the second * containing the rest. - * + * * (1..6).partition {|i| (i&1).zero?} #=> [[2, 4, 6], [1, 3, 5]] - * + * */ static VALUE @@ -610,13 +610,13 @@ group_by_i(i, hash) /* * call-seq: * enum.group_by {| obj | block } => a_hash - * + * * Returns a hash, which keys are evaluated result from the * block, and values are arrays of elements in <i>enum</i> * corresponding to the key. - * + * * (1..6).group_by {|i| i%3} #=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]} - * + * */ static VALUE @@ -659,11 +659,11 @@ first_i(i, ary) * call-seq: * enum.first -> obj or nil * enum.first(n) -> an_array - * + * * Returns the first element, or the first +n+ elements, of the enumerable. * If the enumerable is empty, the first form returns <code>nil</code>, and the * second form returns an empty array. - * + * */ static VALUE @@ -673,7 +673,7 @@ enum_first(argc, argv, obj) VALUE obj; { VALUE n, ary[2]; - + if (argc == 0) { ary[0] = ary[1] = Qnil; } @@ -692,7 +692,7 @@ enum_first(argc, argv, obj) * call-seq: * enum.sort => array * enum.sort {| a, b | block } => array - * + * * Returns an array containing the items in <i>enum</i> sorted, * either according to their own <code><=></code> method, or by using * the results of the supplied block. The block should return -1, 0, or @@ -700,7 +700,7 @@ enum_first(argc, argv, obj) * Ruby 1.8, the method <code>Enumerable#sort_by</code> implements a * built-in Schwartzian Transform, useful when key computation or * comparison is expensive.. - * + * * %w(rhea kea flea).sort #=> ["flea", "kea", "rhea"] * (1..10).sort {|a,b| b <=> a} #=> [10, 9, 8, 7, 6, 5, 4, 3, 2, 1] */ @@ -746,53 +746,53 @@ sort_by_cmp(aa, bb, data) /* * call-seq: * enum.sort_by {| obj | block } => array - * + * * Sorts <i>enum</i> using a set of keys generated by mapping the * values in <i>enum</i> through the given block. - * + * * %w{ apple pear fig }.sort_by {|word| word.length} #=> ["fig", "pear", "apple"] - * + * * The current implementation of <code>sort_by</code> generates an * array of tuples containing the original collection element and the * mapped value. This makes <code>sort_by</code> fairly expensive when * the keysets are simple - * + * * require 'benchmark' * include Benchmark - * + * * a = (1..100000).map {rand(100000)} - * + * * bm(10) do |b| * b.report("Sort") { a.sort } * b.report("Sort by") { a.sort_by {|a| a} } * end - * + * * <em>produces:</em> - * + * * user system total real * Sort 0.180000 0.000000 0.180000 ( 0.175469) * Sort by 1.980000 0.040000 2.020000 ( 2.013586) - * + * * However, consider the case where comparing the keys is a non-trivial * operation. The following code sorts some files on modification time * using the basic <code>sort</code> method. - * + * * files = Dir["*"] * sorted = files.sort {|a,b| File.new(a).mtime <=> File.new(b).mtime} * sorted #=> ["mon", "tues", "wed", "thurs"] - * + * * This sort is inefficient: it generates two new <code>File</code> * objects during every comparison. A slightly better technique is to * use the <code>Kernel#test</code> method to generate the modification * times directly. - * + * * files = Dir["*"] * sorted = files.sort { |a,b| * test(?M, a) <=> test(?M, b) * } * sorted #=> ["mon", "tues", "wed", "thurs"] - * + * * This still generates many unnecessary <code>Time</code> objects. A * more efficient technique is to cache the sort keys (modification * times in this case) before the sort. Perl users often call this @@ -800,14 +800,14 @@ sort_by_cmp(aa, bb, data) * construct a temporary array, where each element is an array * containing our sort key along with the filename. We sort this array, * and then extract the filename from the result. - * + * * sorted = Dir["*"].collect { |f| * [test(?M, f), f] * }.sort.collect { |f| f[1] } * sorted #=> ["mon", "tues", "wed", "thurs"] - * + * * This is exactly what <code>sort_by</code> does internally. - * + * * sorted = Dir["*"].sort_by {|f| test(?M, f)} * sorted #=> ["mon", "tues", "wed", "thurs"] */ @@ -844,11 +844,11 @@ enum_sort_by(obj) } static VALUE -all_iter_i(i, memo) +all_i(i, memo) VALUE i; VALUE *memo; { - if (!RTEST(rb_yield(i))) { + if (!RTEST(i)) { *memo = Qfalse; rb_iter_break(); } @@ -856,32 +856,28 @@ all_iter_i(i, memo) } static VALUE -all_i(i, memo) +all_iter_i(i, memo) VALUE i; VALUE *memo; { - if (!RTEST(i)) { - *memo = Qfalse; - rb_iter_break(); - } - return Qnil; + return all_i(rb_yield(i), memo); } /* * call-seq: * enum.all? [{|obj| block } ] => true or false - * + * * Passes each element of the collection to the given block. The method * returns <code>true</code> if the block never returns * <code>false</code> or <code>nil</code>. If the block is not given, * Ruby adds an implicit block of <code>{|obj| obj}</code> (that is * <code>all?</code> will return <code>true</code> only if none of the * collection members are <code>false</code> or <code>nil</code>.) - * + * * %w{ ant bear cat}.all? {|word| word.length >= 3} #=> true * %w{ ant bear cat}.all? {|word| word.length >= 4} #=> false * [ nil, true, 99 ].all? #=> false - * + * */ static VALUE @@ -895,11 +891,11 @@ enum_all(obj) } static VALUE -any_iter_i(i, memo) +any_i(i, memo) VALUE i; VALUE *memo; { - if (RTEST(rb_yield(i))) { + if (RTEST(i)) { *memo = Qtrue; rb_iter_break(); } @@ -907,21 +903,17 @@ any_iter_i(i, memo) } static VALUE -any_i(i, memo) +any_iter_i(i, memo) VALUE i; VALUE *memo; { - if (RTEST(i)) { - *memo = Qtrue; - rb_iter_break(); - } - return Qnil; + return any_i(rb_yield(i), memo); } /* * call-seq: * enum.any? [{|obj| block } ] => true or false - * + * * Passes each element of the collection to the given block. The method * returns <code>true</code> if the block ever returns a value other * than <code>false</code> or <code>nil</code>. If the block is not @@ -929,11 +921,11 @@ any_i(i, memo) * is <code>any?</code> will return <code>true</code> if at least one * of the collection members is not <code>false</code> or * <code>nil</code>. - * + * * %w{ ant bear cat}.any? {|word| word.length >= 3} #=> true * %w{ ant bear cat}.any? {|word| word.length >= 4} #=> true * [ nil, true, 99 ].any? #=> true - * + * */ static VALUE @@ -974,19 +966,19 @@ one_iter_i(i, memo) /* * call-seq: * enum.one? [{|obj| block }] => true or false - * + * * Passes each element of the collection to the given block. The method * returns <code>true</code> if the block returns <code>true</code> * exactly once. If the block is not given, <code>one?</code> will return * <code>true</code> only if exactly one of the collection members is * true. - * + * * %w{ant bear cat}.one? {|word| word.length == 4} #=> true * %w{ant bear cat}.one? {|word| word.length > 4} #=> false * %w{ant bear cat}.one? {|word| word.length < 4} #=> false * [ nil, true, 99 ].one? #=> false * [ nil, true, false ].one? #=> true - * + * */ static VALUE @@ -1023,12 +1015,12 @@ none_iter_i(i, memo) /* * call-seq: * enum.none? [{|obj| block }] => true or false - * + * * Passes each element of the collection to the given block. The method * returns <code>true</code> if the block never returns <code>true</code> * for all elements. If the block is not given, <code>none?</code> will return * <code>true</code> only if none of the collection members is true. - * + * * %w{ant bear cat}.none? {|word| word.length == 5} #=> true * %w{ant bear cat}.none? {|word| word.length >= 4} #=> false * [].none? #=> true @@ -1088,11 +1080,11 @@ min_ii(i, memo) * call-seq: * enum.min => obj * enum.min {| a,b | block } => obj - * + * * Returns the object in <i>enum</i> with the minimum value. The * first form assumes all objects implement <code>Comparable</code>; * the second uses the block to return <em>a <=> b</em>. - * + * * a = %w(albatross dog horse) * a.min #=> "albatross" * a.min {|a,b| a.length <=> b.length } #=> "dog" @@ -1113,11 +1105,11 @@ enum_min(obj) * call-seq: * enum.max => obj * enum.max {| a,b | block } => obj - * + * * Returns the object in <i>enum</i> with the maximum value. The * first form assumes all objects implement <code>Comparable</code>; * the second uses the block to return <em>a <=> b</em>. - * + * * a = %w(albatross dog horse) * a.max #=> "horse" * a.max {|a,b| a.length <=> b.length } #=> "albatross" @@ -1165,15 +1157,15 @@ max_ii(i, memo) * call-seq: * enum.max => obj * enum.max {|a,b| block } => obj - * + * * Returns the object in _enum_ with the maximum value. The * first form assumes all objects implement <code>Comparable</code>; * the second uses the block to return <em>a <=> b</em>. - * + * * a = %w(albatross dog horse) * a.max #=> "horse" * a.max {|a,b| a.length <=> b.length } #=> "albatross" - */ + */ static VALUE enum_max(obj) @@ -1244,16 +1236,16 @@ minmax_ii(i, memo) * call-seq: * enum.minmax => [min,max] * enum.minmax {|a,b| block } => [min,max] - * + * * Returns two elements array which contains the minimum and the * maximum value in the enumerable. The first form assumes all * objects implement <code>Comparable</code>; the second uses the * block to return <em>a <=> b</em>. - * + * * a = %w(albatross dog horse) * a.minmax #=> ["albatross", "horse"] * a.minmax {|a,b| a.length <=> b.length } #=> ["dog", "albatross"] - */ + */ static VALUE enum_minmax(obj) @@ -1299,10 +1291,10 @@ min_by_i(i, memo) /* * call-seq: * enum.min_by {| obj| block } => obj - * + * * Returns the object in <i>enum</i> that gives the minimum * value from the given block. - * + * * a = %w(albatross dog horse) * a.min_by {|x| x.length } #=> "dog" */ @@ -1343,10 +1335,10 @@ max_by_i(i, memo) /* * call-seq: * enum.max_by {| obj| block } => obj - * + * * Returns the object in <i>enum</i> that gives the maximum * value from the given block. - * + * * a = %w(albatross dog horse) * a.max_by {|x| x.length } #=> "albatross" */ @@ -1364,7 +1356,7 @@ enum_max_by(obj) rb_block_call(obj, id_each, 0, 0, max_by_i, (VALUE)memo); return memo[1]; } - + static VALUE minmax_by_i(i, memo) VALUE i; @@ -1395,11 +1387,11 @@ minmax_by_i(i, memo) /* * call-seq: * enum.minmax_by {| obj| block } => [min, max] - * + * * Returns two elements array array containing the objects in * <i>enum</i> that gives the minimum and maximum values respectively * from the given block. - * + * * a = %w(albatross dog horse) * a.minmax_by {|x| x.length } #=> ["dog", "albatross"] */ @@ -1436,13 +1428,13 @@ member_i(item, memo) * call-seq: * enum.include?(obj) => true or false * enum.member?(obj) => true or false - * + * * Returns <code>true</code> if any member of <i>enum</i> equals * <i>obj</i>. Equality is tested using <code>==</code>. - * + * * IO.constants.include? "SEEK_SET" #=> true * IO.constants.include? "SEEK_NO_FURTHER" #=> false - * + * */ static VALUE @@ -1470,16 +1462,16 @@ each_with_index_i(val, memo) /* * call-seq: * enum.each_with_index {|obj, i| block } -> enum - * + * * Calls <em>block</em> with two arguments, the item and its index, for * each item in <i>enum</i>. - * + * * hash = Hash.new * %w(cat dog wombat).each_with_index {|item, index| * hash[item] = index * } * hash #=> {"cat"=>0, "wombat"=>2, "dog"=>1} - * + * */ static VALUE @@ -1524,7 +1516,7 @@ zip_i(val, memo) * call-seq: * enum.zip(arg, ...) => array * enum.zip(arg, ...) {|arr| block } => nil - * + * * Converts any arguments to arrays, then merges elements of * <i>enum</i> with corresponding elements from each argument. This * generates a sequence of <code>enum#size</code> <em>n</em>-element @@ -1533,14 +1525,14 @@ zip_i(val, memo) * <code>nil</code> values are supplied. If a block given, it is * invoked for each output array, otherwise an array of arrays is * returned. - * + * * a = [ 4, 5, 6 ] * b = [ 7, 8, 9 ] - * + * * (1..3).zip(a, b) #=> [[1, 4, 7], [2, 5, 8], [3, 6, 9]] * "cat\ndog".zip([1]) #=> [["cat\n", 1], ["dog", nil]] * (1..3).zip #=> [[1], [2], [3]] - * + * */ static VALUE @@ -1578,12 +1570,12 @@ take_i(i, arg) /* * call-seq: * enum.take(n) => array - * + * * Returns first n elements from <i>enum</i>. - * + * * a = [1, 2, 3, 4, 5, 0] * a.take(3) # => [1, 2, 3] - * + * */ static VALUE @@ -1618,13 +1610,13 @@ take_while_i(i, ary) /* * call-seq: * enum.take_while {|arr| block } => array - * + * * Passes elements to the block until the block returns nil or false, * then stops iterating and returns an array of all prior elements. - * + * * a = [1, 2, 3, 4, 5, 0] * a.take_while {|i| i < 3 } # => [1, 2] - * + * */ static VALUE @@ -1656,13 +1648,13 @@ drop_i(i, arg) /* * call-seq: * enum.drop(n) => array - * + * * Drops first n elements from <i>enum</i>, and returns rest elements * in an array. - * + * * a = [1, 2, 3, 4, 5, 0] * a.drop(3) # => [4, 5, 0] - * + * */ static VALUE @@ -1701,14 +1693,14 @@ drop_while_i(i, args) /* * call-seq: * enum.drop_while {|arr| block } => array - * + * * Drops elements up to, but not including, the first element for * which the block returns nil or false and returns an array * containing the remaining elements. - * + * * a = [1, 2, 3, 4, 5, 0] * a.drop_while {|i| i < 3 } # => [3, 4, 5, 0] - * + * */ static VALUE @@ -1738,7 +1730,7 @@ cycle_i(i, ary) * call-seq: * enum.cycle {|obj| block } * enum.cycle(n) {|obj| block } - * + * * Calls <i>block</i> for each element of <i>enum</i> repeatedly _n_ * times or forever if none or nil is given. If a non-positive * number is given or the collection is empty, does nothing. Returns @@ -1746,11 +1738,11 @@ cycle_i(i, ary) * * Enumerable#cycle saves elements in an internal array so changes * to <i>enum</i> after the first pass have no effect. - * + * * a = ["a", "b", "c"] * a.cycle {|x| puts x } # print, a, b, c, a, b, c,.. forever. * a.cycle(2) {|x| puts x } # print, a, b, c, a, b, c. - * + * */ static VALUE @@ -1829,8 +1821,8 @@ Init_Enumerable() rb_define_method(rb_mEnumerable,"min", enum_min, 0); rb_define_method(rb_mEnumerable,"max", enum_max, 0); rb_define_method(rb_mEnumerable,"minmax", enum_minmax, 0); - rb_define_method(rb_mEnumerable,"min_by", enum_min_by, 0); - rb_define_method(rb_mEnumerable,"max_by", enum_max_by, 0); + rb_define_method(rb_mEnumerable,"min_by", enum_min_by, 0); + rb_define_method(rb_mEnumerable,"max_by", enum_max_by, 0); rb_define_method(rb_mEnumerable,"minmax_by", enum_minmax_by, 0); rb_define_method(rb_mEnumerable,"member?", enum_member, 1); rb_define_method(rb_mEnumerable,"include?", enum_member, 1); |