Ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e0ba6b95ab71a441357ed5484e33498)
range.c
1/**********************************************************************
2
3 range.c -
4
5 $Author$
6 created at: Thu Aug 19 17:46:47 JST 1993
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9
10**********************************************************************/
11
12#include "ruby/internal/config.h"
13
14#include <assert.h>
15#include <math.h>
16
17#ifdef HAVE_FLOAT_H
18#include <float.h>
19#endif
20
21#include "id.h"
22#include "internal.h"
23#include "internal/array.h"
24#include "internal/compar.h"
25#include "internal/enum.h"
26#include "internal/enumerator.h"
27#include "internal/error.h"
28#include "internal/numeric.h"
29#include "internal/range.h"
30
32static ID id_beg, id_end, id_excl;
33#define id_cmp idCmp
34#define id_succ idSucc
35#define id_min idMin
36#define id_max idMax
37
38static VALUE r_cover_p(VALUE, VALUE, VALUE, VALUE);
39
40#define RANGE_SET_BEG(r, v) (RSTRUCT_SET(r, 0, v))
41#define RANGE_SET_END(r, v) (RSTRUCT_SET(r, 1, v))
42#define RANGE_SET_EXCL(r, v) (RSTRUCT_SET(r, 2, v))
43
44#define EXCL(r) RTEST(RANGE_EXCL(r))
45
46static void
47range_init(VALUE range, VALUE beg, VALUE end, VALUE exclude_end)
48{
49 if ((!FIXNUM_P(beg) || !FIXNUM_P(end)) && !NIL_P(beg) && !NIL_P(end)) {
50 VALUE v;
51
52 v = rb_funcall(beg, id_cmp, 1, end);
53 if (NIL_P(v))
54 rb_raise(rb_eArgError, "bad value for range");
55 }
56
57 RANGE_SET_EXCL(range, exclude_end);
58 RANGE_SET_BEG(range, beg);
59 RANGE_SET_END(range, end);
60
61 if (CLASS_OF(range) == rb_cRange) {
62 rb_obj_freeze(range);
63 }
64}
65
66VALUE
67rb_range_new(VALUE beg, VALUE end, int exclude_end)
68{
69 VALUE range = rb_obj_alloc(rb_cRange);
70
71 range_init(range, beg, end, RBOOL(exclude_end));
72 return range;
73}
74
75static void
76range_modify(VALUE range)
77{
78 rb_check_frozen(range);
79 /* Ranges are immutable, so that they should be initialized only once. */
80 if (RANGE_EXCL(range) != Qnil) {
81 rb_name_err_raise("`initialize' called twice", range, ID2SYM(idInitialize));
82 }
83}
84
85/*
86 * call-seq:
87 * Range.new(begin, end, exclude_end = false) -> new_range
88 *
89 * Returns a new range based on the given objects +begin+ and +end+.
90 * Optional argument +exclude_end+ determines whether object +end+
91 * is included as the last object in the range:
92 *
93 * Range.new(2, 5).to_a # => [2, 3, 4, 5]
94 * Range.new(2, 5, true).to_a # => [2, 3, 4]
95 * Range.new('a', 'd').to_a # => ["a", "b", "c", "d"]
96 * Range.new('a', 'd', true).to_a # => ["a", "b", "c"]
97 *
98 */
99
100static VALUE
101range_initialize(int argc, VALUE *argv, VALUE range)
102{
103 VALUE beg, end, flags;
104
105 rb_scan_args(argc, argv, "21", &beg, &end, &flags);
106 range_modify(range);
107 range_init(range, beg, end, RBOOL(RTEST(flags)));
108 return Qnil;
109}
110
111/* :nodoc: */
112static VALUE
113range_initialize_copy(VALUE range, VALUE orig)
114{
115 range_modify(range);
116 rb_struct_init_copy(range, orig);
117 return range;
118}
119
120/*
121 * call-seq:
122 * exclude_end? -> true or false
123 *
124 * Returns +true+ if +self+ excludes its end value; +false+ otherwise:
125 *
126 * Range.new(2, 5).exclude_end? # => false
127 * Range.new(2, 5, true).exclude_end? # => true
128 * (2..5).exclude_end? # => false
129 * (2...5).exclude_end? # => true
130 */
131
132static VALUE
133range_exclude_end_p(VALUE range)
134{
135 return RBOOL(EXCL(range));
136}
137
138static VALUE
139recursive_equal(VALUE range, VALUE obj, int recur)
140{
141 if (recur) return Qtrue; /* Subtle! */
142 if (!rb_equal(RANGE_BEG(range), RANGE_BEG(obj)))
143 return Qfalse;
144 if (!rb_equal(RANGE_END(range), RANGE_END(obj)))
145 return Qfalse;
146
147 return RBOOL(EXCL(range) == EXCL(obj));
148}
149
150
151/*
152 * call-seq:
153 * self == other -> true or false
154 *
155 * Returns +true+ if and only if:
156 *
157 * - +other+ is a range.
158 * - <tt>other.begin == self.begin</tt>.
159 * - <tt>other.end == self.end</tt>.
160 * - <tt>other.exclude_end? == self.exclude_end?</tt>.
161 *
162 * Otherwise returns +false+.
163 *
164 * r = (1..5)
165 * r == (1..5) # => true
166 * r = Range.new(1, 5)
167 * r == 'foo' # => false
168 * r == (2..5) # => false
169 * r == (1..4) # => false
170 * r == (1...5) # => false
171 * r == Range.new(1, 5, true) # => false
172 *
173 * Note that even with the same argument, the return values of #== and #eql? can differ:
174 *
175 * (1..2) == (1..2.0) # => true
176 * (1..2).eql? (1..2.0) # => false
177 *
178 * Related: Range#eql?.
179 *
180 */
181
182static VALUE
183range_eq(VALUE range, VALUE obj)
184{
185 if (range == obj)
186 return Qtrue;
187 if (!rb_obj_is_kind_of(obj, rb_cRange))
188 return Qfalse;
189
190 return rb_exec_recursive_paired(recursive_equal, range, obj, obj);
191}
192
193/* compares _a_ and _b_ and returns:
194 * < 0: a < b
195 * = 0: a = b
196 * > 0: a > b or non-comparable
197 */
198static int
199r_less(VALUE a, VALUE b)
200{
201 VALUE r = rb_funcall(a, id_cmp, 1, b);
202
203 if (NIL_P(r))
204 return INT_MAX;
205 return rb_cmpint(r, a, b);
206}
207
208static VALUE
209recursive_eql(VALUE range, VALUE obj, int recur)
210{
211 if (recur) return Qtrue; /* Subtle! */
212 if (!rb_eql(RANGE_BEG(range), RANGE_BEG(obj)))
213 return Qfalse;
214 if (!rb_eql(RANGE_END(range), RANGE_END(obj)))
215 return Qfalse;
216
217 return RBOOL(EXCL(range) == EXCL(obj));
218}
219
220/*
221 * call-seq:
222 * eql?(other) -> true or false
223 *
224 * Returns +true+ if and only if:
225 *
226 * - +other+ is a range.
227 * - <tt>other.begin eql? self.begin</tt>.
228 * - <tt>other.end eql? self.end</tt>.
229 * - <tt>other.exclude_end? == self.exclude_end?</tt>.
230 *
231 * Otherwise returns +false+.
232 *
233 * r = (1..5)
234 * r.eql?(1..5) # => true
235 * r = Range.new(1, 5)
236 * r.eql?('foo') # => false
237 * r.eql?(2..5) # => false
238 * r.eql?(1..4) # => false
239 * r.eql?(1...5) # => false
240 * r.eql?(Range.new(1, 5, true)) # => false
241 *
242 * Note that even with the same argument, the return values of #== and #eql? can differ:
243 *
244 * (1..2) == (1..2.0) # => true
245 * (1..2).eql? (1..2.0) # => false
246 *
247 * Related: Range#==.
248 */
249
250static VALUE
251range_eql(VALUE range, VALUE obj)
252{
253 if (range == obj)
254 return Qtrue;
255 if (!rb_obj_is_kind_of(obj, rb_cRange))
256 return Qfalse;
257 return rb_exec_recursive_paired(recursive_eql, range, obj, obj);
258}
259
260/*
261 * call-seq:
262 * hash -> integer
263 *
264 * Returns the integer hash value for +self+.
265 * Two range objects +r0+ and +r1+ have the same hash value
266 * if and only if <tt>r0.eql?(r1)</tt>.
267 *
268 * Related: Range#eql?, Object#hash.
269 */
270
271static VALUE
272range_hash(VALUE range)
273{
274 st_index_t hash = EXCL(range);
275 VALUE v;
276
277 hash = rb_hash_start(hash);
278 v = rb_hash(RANGE_BEG(range));
279 hash = rb_hash_uint(hash, NUM2LONG(v));
280 v = rb_hash(RANGE_END(range));
281 hash = rb_hash_uint(hash, NUM2LONG(v));
282 hash = rb_hash_uint(hash, EXCL(range) << 24);
283 hash = rb_hash_end(hash);
284
285 return ST2FIX(hash);
286}
287
288static void
289range_each_func(VALUE range, int (*func)(VALUE, VALUE), VALUE arg)
290{
291 int c;
292 VALUE b = RANGE_BEG(range);
293 VALUE e = RANGE_END(range);
294 VALUE v = b;
295
296 if (EXCL(range)) {
297 while (r_less(v, e) < 0) {
298 if ((*func)(v, arg)) break;
299 v = rb_funcallv(v, id_succ, 0, 0);
300 }
301 }
302 else {
303 while ((c = r_less(v, e)) <= 0) {
304 if ((*func)(v, arg)) break;
305 if (!c) break;
306 v = rb_funcallv(v, id_succ, 0, 0);
307 }
308 }
309}
310
311static bool
312step_i_iter(VALUE arg)
313{
314 VALUE *iter = (VALUE *)arg;
315
316 if (FIXNUM_P(iter[0])) {
317 iter[0] -= INT2FIX(1) & ~FIXNUM_FLAG;
318 }
319 else {
320 iter[0] = rb_funcall(iter[0], '-', 1, INT2FIX(1));
321 }
322 if (iter[0] != INT2FIX(0)) return false;
323 iter[0] = iter[1];
324 return true;
325}
326
327static int
328sym_step_i(VALUE i, VALUE arg)
329{
330 if (step_i_iter(arg)) {
332 }
333 return 0;
334}
335
336static int
337step_i(VALUE i, VALUE arg)
338{
339 if (step_i_iter(arg)) {
340 rb_yield(i);
341 }
342 return 0;
343}
344
345static int
346discrete_object_p(VALUE obj)
347{
348 return rb_respond_to(obj, id_succ);
349}
350
351static int
352linear_object_p(VALUE obj)
353{
354 if (FIXNUM_P(obj) || FLONUM_P(obj)) return TRUE;
355 if (SPECIAL_CONST_P(obj)) return FALSE;
356 switch (BUILTIN_TYPE(obj)) {
357 case T_FLOAT:
358 case T_BIGNUM:
359 return TRUE;
360 default:
361 break;
362 }
363 if (rb_obj_is_kind_of(obj, rb_cNumeric)) return TRUE;
364 if (rb_obj_is_kind_of(obj, rb_cTime)) return TRUE;
365 return FALSE;
366}
367
368static VALUE
369check_step_domain(VALUE step)
370{
371 VALUE zero = INT2FIX(0);
372 int cmp;
373 if (!rb_obj_is_kind_of(step, rb_cNumeric)) {
374 step = rb_to_int(step);
375 }
376 cmp = rb_cmpint(rb_funcallv(step, idCmp, 1, &zero), step, zero);
377 if (cmp < 0) {
378 rb_raise(rb_eArgError, "step can't be negative");
379 }
380 else if (cmp == 0) {
381 rb_raise(rb_eArgError, "step can't be 0");
382 }
383 return step;
384}
385
386static VALUE
387range_step_size(VALUE range, VALUE args, VALUE eobj)
388{
389 VALUE b = RANGE_BEG(range), e = RANGE_END(range);
390 VALUE step = INT2FIX(1);
391 if (args) {
392 step = check_step_domain(RARRAY_AREF(args, 0));
393 }
394
395 if (rb_obj_is_kind_of(b, rb_cNumeric) && rb_obj_is_kind_of(e, rb_cNumeric)) {
396 return ruby_num_interval_step_size(b, e, step, EXCL(range));
397 }
398 return Qnil;
399}
400
401/*
402 * call-seq:
403 * step(n = 1) {|element| ... } -> self
404 * step(n = 1) -> enumerator
405 *
406 * Iterates over the elements of +self+.
407 *
408 * With a block given and no argument,
409 * calls the block each element of the range; returns +self+:
410 *
411 * a = []
412 * (1..5).step {|element| a.push(element) } # => 1..5
413 * a # => [1, 2, 3, 4, 5]
414 * a = []
415 * ('a'..'e').step {|element| a.push(element) } # => "a".."e"
416 * a # => ["a", "b", "c", "d", "e"]
417 *
418 * With a block given and a positive integer argument +n+ given,
419 * calls the block with element +0+, element +n+, element <tt>2n</tt>, and so on:
420 *
421 * a = []
422 * (1..5).step(2) {|element| a.push(element) } # => 1..5
423 * a # => [1, 3, 5]
424 * a = []
425 * ('a'..'e').step(2) {|element| a.push(element) } # => "a".."e"
426 * a # => ["a", "c", "e"]
427 *
428 * With no block given, returns an enumerator,
429 * which will be of class Enumerator::ArithmeticSequence if +self+ is numeric;
430 * otherwise of class Enumerator:
431 *
432 * e = (1..5).step(2) # => ((1..5).step(2))
433 * e.class # => Enumerator::ArithmeticSequence
434 * ('a'..'e').step # => #<Enumerator: ...>
435 *
436 * Related: Range#%.
437 */
438static VALUE
439range_step(int argc, VALUE *argv, VALUE range)
440{
441 VALUE b, e, step, tmp;
442
443 b = RANGE_BEG(range);
444 e = RANGE_END(range);
445 step = (!rb_check_arity(argc, 0, 1) ? INT2FIX(1) : argv[0]);
446
447 if (!rb_block_given_p()) {
448 if (!rb_obj_is_kind_of(step, rb_cNumeric)) {
449 step = rb_to_int(step);
450 }
451 if (rb_equal(step, INT2FIX(0))) {
452 rb_raise(rb_eArgError, "step can't be 0");
453 }
454
455 const VALUE b_num_p = rb_obj_is_kind_of(b, rb_cNumeric);
456 const VALUE e_num_p = rb_obj_is_kind_of(e, rb_cNumeric);
457 if ((b_num_p && (NIL_P(e) || e_num_p)) || (NIL_P(b) && e_num_p)) {
458 return rb_arith_seq_new(range, ID2SYM(rb_frame_this_func()), argc, argv,
459 range_step_size, b, e, step, EXCL(range));
460 }
461
462 RETURN_SIZED_ENUMERATOR(range, argc, argv, range_step_size);
463 }
464
465 step = check_step_domain(step);
466 VALUE iter[2] = {INT2FIX(1), step};
467
468 if (FIXNUM_P(b) && NIL_P(e) && FIXNUM_P(step)) {
469 long i = FIX2LONG(b), unit = FIX2LONG(step);
470 do {
471 rb_yield(LONG2FIX(i));
472 i += unit; /* FIXABLE+FIXABLE never overflow */
473 } while (FIXABLE(i));
474 b = LONG2NUM(i);
475
476 for (;; b = rb_big_plus(b, step))
477 rb_yield(b);
478 }
479 else if (FIXNUM_P(b) && FIXNUM_P(e) && FIXNUM_P(step)) { /* fixnums are special */
480 long end = FIX2LONG(e);
481 long i, unit = FIX2LONG(step);
482
483 if (!EXCL(range))
484 end += 1;
485 i = FIX2LONG(b);
486 while (i < end) {
487 rb_yield(LONG2NUM(i));
488 if (i + unit < i) break;
489 i += unit;
490 }
491
492 }
493 else if (SYMBOL_P(b) && (NIL_P(e) || SYMBOL_P(e))) { /* symbols are special */
494 b = rb_sym2str(b);
495 if (NIL_P(e)) {
496 rb_str_upto_endless_each(b, sym_step_i, (VALUE)iter);
497 }
498 else {
499 rb_str_upto_each(b, rb_sym2str(e), EXCL(range), sym_step_i, (VALUE)iter);
500 }
501 }
502 else if (ruby_float_step(b, e, step, EXCL(range), TRUE)) {
503 /* done */
504 }
505 else if (rb_obj_is_kind_of(b, rb_cNumeric) ||
506 !NIL_P(rb_check_to_integer(b, "to_int")) ||
507 !NIL_P(rb_check_to_integer(e, "to_int"))) {
508 ID op = EXCL(range) ? '<' : idLE;
509 VALUE v = b;
510 int i = 0;
511
512 while (NIL_P(e) || RTEST(rb_funcall(v, op, 1, e))) {
513 rb_yield(v);
514 i++;
515 v = rb_funcall(b, '+', 1, rb_funcall(INT2NUM(i), '*', 1, step));
516 }
517 }
518 else {
519 tmp = rb_check_string_type(b);
520
521 if (!NIL_P(tmp)) {
522 b = tmp;
523 if (NIL_P(e)) {
524 rb_str_upto_endless_each(b, step_i, (VALUE)iter);
525 }
526 else {
527 rb_str_upto_each(b, e, EXCL(range), step_i, (VALUE)iter);
528 }
529 }
530 else {
531 if (!discrete_object_p(b)) {
532 rb_raise(rb_eTypeError, "can't iterate from %s",
534 }
535 range_each_func(range, step_i, (VALUE)iter);
536 }
537 }
538 return range;
539}
540
541/*
542 * call-seq:
543 * %(n) {|element| ... } -> self
544 * %(n) -> enumerator
545 *
546 * Iterates over the elements of +self+.
547 *
548 * With a block given, calls the block with selected elements of the range;
549 * returns +self+:
550 *
551 * a = []
552 * (1..5).%(2) {|element| a.push(element) } # => 1..5
553 * a # => [1, 3, 5]
554 * a = []
555 * ('a'..'e').%(2) {|element| a.push(element) } # => "a".."e"
556 * a # => ["a", "c", "e"]
557 *
558 * With no block given, returns an enumerator,
559 * which will be of class Enumerator::ArithmeticSequence if +self+ is numeric;
560 * otherwise of class Enumerator:
561 *
562 * e = (1..5) % 2 # => ((1..5).%(2))
563 * e.class # => Enumerator::ArithmeticSequence
564 * ('a'..'e') % 2 # => #<Enumerator: ...>
565 *
566 * Related: Range#step.
567 */
568static VALUE
569range_percent_step(VALUE range, VALUE step)
570{
571 return range_step(1, &step, range);
572}
573
574#if SIZEOF_DOUBLE == 8 && defined(HAVE_INT64_T)
575union int64_double {
576 int64_t i;
577 double d;
578};
579
580static VALUE
581int64_as_double_to_num(int64_t i)
582{
583 union int64_double convert;
584 if (i < 0) {
585 convert.i = -i;
586 return DBL2NUM(-convert.d);
587 }
588 else {
589 convert.i = i;
590 return DBL2NUM(convert.d);
591 }
592}
593
594static int64_t
595double_as_int64(double d)
596{
597 union int64_double convert;
598 convert.d = fabs(d);
599 return d < 0 ? -convert.i : convert.i;
600}
601#endif
602
603static int
604is_integer_p(VALUE v)
605{
606 ID id_integer_p;
607 VALUE is_int;
608 CONST_ID(id_integer_p, "integer?");
609 is_int = rb_check_funcall(v, id_integer_p, 0, 0);
610 return RTEST(is_int) && is_int != Qundef;
611}
612
613static VALUE
614bsearch_integer_range(VALUE beg, VALUE end, int excl)
615{
616 VALUE satisfied = Qnil;
617 int smaller;
618
619#define BSEARCH_CHECK(expr) \
620 do { \
621 VALUE val = (expr); \
622 VALUE v = rb_yield(val); \
623 if (FIXNUM_P(v)) { \
624 if (v == INT2FIX(0)) return val; \
625 smaller = (SIGNED_VALUE)v < 0; \
626 } \
627 else if (v == Qtrue) { \
628 satisfied = val; \
629 smaller = 1; \
630 } \
631 else if (!RTEST(v)) { \
632 smaller = 0; \
633 } \
634 else if (rb_obj_is_kind_of(v, rb_cNumeric)) { \
635 int cmp = rb_cmpint(rb_funcall(v, id_cmp, 1, INT2FIX(0)), v, INT2FIX(0)); \
636 if (!cmp) return val; \
637 smaller = cmp < 0; \
638 } \
639 else { \
640 rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE \
641 " (must be numeric, true, false or nil)", \
642 rb_obj_class(v)); \
643 } \
644 } while (0)
645
646 VALUE low = rb_to_int(beg);
647 VALUE high = rb_to_int(end);
648 VALUE mid, org_high;
649 ID id_div;
650 CONST_ID(id_div, "div");
651
652 if (excl) high = rb_funcall(high, '-', 1, INT2FIX(1));
653 org_high = high;
654
655 while (rb_cmpint(rb_funcall(low, id_cmp, 1, high), low, high) < 0) {
656 mid = rb_funcall(rb_funcall(high, '+', 1, low), id_div, 1, INT2FIX(2));
657 BSEARCH_CHECK(mid);
658 if (smaller) {
659 high = mid;
660 }
661 else {
662 low = rb_funcall(mid, '+', 1, INT2FIX(1));
663 }
664 }
665 if (rb_equal(low, org_high)) {
666 BSEARCH_CHECK(low);
667 if (!smaller) return Qnil;
668 }
669 return satisfied;
670}
671
672/*
673 * call-seq:
674 * bsearch {|obj| block } -> value
675 *
676 * Returns an element from +self+ selected by a binary search.
677 *
678 * See {Binary Searching}[rdoc-ref:bsearch.rdoc].
679 *
680 */
681
682static VALUE
683range_bsearch(VALUE range)
684{
685 VALUE beg, end, satisfied = Qnil;
686 int smaller;
687
688 /* Implementation notes:
689 * Floats are handled by mapping them to 64 bits integers.
690 * Apart from sign issues, floats and their 64 bits integer have the
691 * same order, assuming they are represented as exponent followed
692 * by the mantissa. This is true with or without implicit bit.
693 *
694 * Finding the average of two ints needs to be careful about
695 * potential overflow (since float to long can use 64 bits)
696 * as well as the fact that -1/2 can be 0 or -1 in C89.
697 *
698 * Note that -0.0 is mapped to the same int as 0.0 as we don't want
699 * (-1...0.0).bsearch to yield -0.0.
700 */
701
702#define BSEARCH(conv) \
703 do { \
704 RETURN_ENUMERATOR(range, 0, 0); \
705 if (EXCL(range)) high--; \
706 org_high = high; \
707 while (low < high) { \
708 mid = ((high < 0) == (low < 0)) ? low + ((high - low) / 2) \
709 : (low < -high) ? -((-1 - low - high)/2 + 1) : (low + high) / 2; \
710 BSEARCH_CHECK(conv(mid)); \
711 if (smaller) { \
712 high = mid; \
713 } \
714 else { \
715 low = mid + 1; \
716 } \
717 } \
718 if (low == org_high) { \
719 BSEARCH_CHECK(conv(low)); \
720 if (!smaller) return Qnil; \
721 } \
722 return satisfied; \
723 } while (0)
724
725
726 beg = RANGE_BEG(range);
727 end = RANGE_END(range);
728
729 if (FIXNUM_P(beg) && FIXNUM_P(end)) {
730 long low = FIX2LONG(beg);
731 long high = FIX2LONG(end);
732 long mid, org_high;
733 BSEARCH(INT2FIX);
734 }
735#if SIZEOF_DOUBLE == 8 && defined(HAVE_INT64_T)
736 else if (RB_FLOAT_TYPE_P(beg) || RB_FLOAT_TYPE_P(end)) {
737 int64_t low = double_as_int64(NIL_P(beg) ? -HUGE_VAL : RFLOAT_VALUE(rb_Float(beg)));
738 int64_t high = double_as_int64(NIL_P(end) ? HUGE_VAL : RFLOAT_VALUE(rb_Float(end)));
739 int64_t mid, org_high;
740 BSEARCH(int64_as_double_to_num);
741 }
742#endif
743 else if (is_integer_p(beg) && is_integer_p(end)) {
744 RETURN_ENUMERATOR(range, 0, 0);
745 return bsearch_integer_range(beg, end, EXCL(range));
746 }
747 else if (is_integer_p(beg) && NIL_P(end)) {
748 VALUE diff = LONG2FIX(1);
749 RETURN_ENUMERATOR(range, 0, 0);
750 while (1) {
751 VALUE mid = rb_funcall(beg, '+', 1, diff);
752 BSEARCH_CHECK(mid);
753 if (smaller) {
754 return bsearch_integer_range(beg, mid, 0);
755 }
756 diff = rb_funcall(diff, '*', 1, LONG2FIX(2));
757 }
758 }
759 else if (NIL_P(beg) && is_integer_p(end)) {
760 VALUE diff = LONG2FIX(-1);
761 RETURN_ENUMERATOR(range, 0, 0);
762 while (1) {
763 VALUE mid = rb_funcall(end, '+', 1, diff);
764 BSEARCH_CHECK(mid);
765 if (!smaller) {
766 return bsearch_integer_range(mid, end, 0);
767 }
768 diff = rb_funcall(diff, '*', 1, LONG2FIX(2));
769 }
770 }
771 else {
772 rb_raise(rb_eTypeError, "can't do binary search for %s", rb_obj_classname(beg));
773 }
774 return range;
775}
776
777static int
778each_i(VALUE v, VALUE arg)
779{
780 rb_yield(v);
781 return 0;
782}
783
784static int
785sym_each_i(VALUE v, VALUE arg)
786{
787 return each_i(rb_str_intern(v), arg);
788}
789
790/*
791 * call-seq:
792 * size -> non_negative_integer or Infinity or nil
793 *
794 * Returns the count of elements in +self+
795 * if both begin and end values are numeric;
796 * otherwise, returns +nil+:
797 *
798 * (1..4).size # => 4
799 * (1...4).size # => 3
800 * (1..).size # => Infinity
801 * ('a'..'z').size #=> nil
802 *
803 * Related: Range#count.
804 */
805
806static VALUE
807range_size(VALUE range)
808{
809 VALUE b = RANGE_BEG(range), e = RANGE_END(range);
810 if (rb_obj_is_kind_of(b, rb_cNumeric)) {
811 if (rb_obj_is_kind_of(e, rb_cNumeric)) {
812 return ruby_num_interval_step_size(b, e, INT2FIX(1), EXCL(range));
813 }
814 if (NIL_P(e)) {
815 return DBL2NUM(HUGE_VAL);
816 }
817 }
818 else if (NIL_P(b)) {
819 return DBL2NUM(HUGE_VAL);
820 }
821
822 return Qnil;
823}
824
825/*
826 * call-seq:
827 * to_a -> array
828 *
829 * Returns an array containing the elements in +self+, if a finite collection;
830 * raises an exception otherwise.
831 *
832 * (1..4).to_a # => [1, 2, 3, 4]
833 * (1...4).to_a # => [1, 2, 3]
834 * ('a'..'d').to_a # => ["a", "b", "c", "d"]
835 *
836 * Range#entries is an alias for Range#to_a.
837 */
838
839static VALUE
840range_to_a(VALUE range)
841{
842 if (NIL_P(RANGE_END(range))) {
843 rb_raise(rb_eRangeError, "cannot convert endless range to an array");
844 }
845 return rb_call_super(0, 0);
846}
847
848static VALUE
849range_enum_size(VALUE range, VALUE args, VALUE eobj)
850{
851 return range_size(range);
852}
853
855static void
856range_each_bignum_endless(VALUE beg)
857{
858 for (;; beg = rb_big_plus(beg, INT2FIX(1))) {
859 rb_yield(beg);
860 }
862}
863
865static void
866range_each_fixnum_endless(VALUE beg)
867{
868 for (long i = FIX2LONG(beg); FIXABLE(i); i++) {
869 rb_yield(LONG2FIX(i));
870 }
871
872 range_each_bignum_endless(LONG2NUM(RUBY_FIXNUM_MAX + 1));
874}
875
876static VALUE
877range_each_fixnum_loop(VALUE beg, VALUE end, VALUE range)
878{
879 long lim = FIX2LONG(end) + !EXCL(range);
880 for (long i = FIX2LONG(beg); i < lim; i++) {
881 rb_yield(LONG2FIX(i));
882 }
883 return range;
884}
885
886/*
887 * call-seq:
888 * each {|element| ... } -> self
889 * each -> an_enumerator
890 *
891 * With a block given, passes each element of +self+ to the block:
892 *
893 * a = []
894 * (1..4).each {|element| a.push(element) } # => 1..4
895 * a # => [1, 2, 3, 4]
896 *
897 * Raises an exception unless <tt>self.first.respond_to?(:succ)</tt>.
898 *
899 * With no block given, returns an enumerator.
900 *
901 */
902
903static VALUE
904range_each(VALUE range)
905{
906 VALUE beg, end;
907 long i;
908
909 RETURN_SIZED_ENUMERATOR(range, 0, 0, range_enum_size);
910
911 beg = RANGE_BEG(range);
912 end = RANGE_END(range);
913
914 if (FIXNUM_P(beg) && NIL_P(end)) {
915 range_each_fixnum_endless(beg);
916 }
917 else if (FIXNUM_P(beg) && FIXNUM_P(end)) { /* fixnums are special */
918 return range_each_fixnum_loop(beg, end, range);
919 }
920 else if (RB_INTEGER_TYPE_P(beg) && (NIL_P(end) || RB_INTEGER_TYPE_P(end))) {
921 if (SPECIAL_CONST_P(end) || RBIGNUM_POSITIVE_P(end)) { /* end >= FIXNUM_MIN */
922 if (!FIXNUM_P(beg)) {
923 if (RBIGNUM_NEGATIVE_P(beg)) {
924 do {
925 rb_yield(beg);
926 } while (!FIXNUM_P(beg = rb_big_plus(beg, INT2FIX(1))));
927 if (NIL_P(end)) range_each_fixnum_endless(beg);
928 if (FIXNUM_P(end)) return range_each_fixnum_loop(beg, end, range);
929 }
930 else {
931 if (NIL_P(end)) range_each_bignum_endless(beg);
932 if (FIXNUM_P(end)) return range;
933 }
934 }
935 if (FIXNUM_P(beg)) {
936 i = FIX2LONG(beg);
937 do {
938 rb_yield(LONG2FIX(i));
939 } while (POSFIXABLE(++i));
940 beg = LONG2NUM(i);
941 }
942 ASSUME(!FIXNUM_P(beg));
943 ASSUME(!SPECIAL_CONST_P(end));
944 }
945 if (!FIXNUM_P(beg) && RBIGNUM_SIGN(beg) == RBIGNUM_SIGN(end)) {
946 if (EXCL(range)) {
947 while (rb_big_cmp(beg, end) == INT2FIX(-1)) {
948 rb_yield(beg);
949 beg = rb_big_plus(beg, INT2FIX(1));
950 }
951 }
952 else {
953 VALUE c;
954 while ((c = rb_big_cmp(beg, end)) != INT2FIX(1)) {
955 rb_yield(beg);
956 if (c == INT2FIX(0)) break;
957 beg = rb_big_plus(beg, INT2FIX(1));
958 }
959 }
960 }
961 }
962 else if (SYMBOL_P(beg) && (NIL_P(end) || SYMBOL_P(end))) { /* symbols are special */
963 beg = rb_sym2str(beg);
964 if (NIL_P(end)) {
965 rb_str_upto_endless_each(beg, sym_each_i, 0);
966 }
967 else {
968 rb_str_upto_each(beg, rb_sym2str(end), EXCL(range), sym_each_i, 0);
969 }
970 }
971 else {
972 VALUE tmp = rb_check_string_type(beg);
973
974 if (!NIL_P(tmp)) {
975 if (!NIL_P(end)) {
976 rb_str_upto_each(tmp, end, EXCL(range), each_i, 0);
977 }
978 else {
979 rb_str_upto_endless_each(tmp, each_i, 0);
980 }
981 }
982 else {
983 if (!discrete_object_p(beg)) {
984 rb_raise(rb_eTypeError, "can't iterate from %s",
985 rb_obj_classname(beg));
986 }
987 if (!NIL_P(end))
988 range_each_func(range, each_i, 0);
989 else
990 for (;; beg = rb_funcallv(beg, id_succ, 0, 0))
991 rb_yield(beg);
992 }
993 }
994 return range;
995}
996
997/*
998 * call-seq:
999 * self.begin -> object
1000 *
1001 * Returns the object that defines the beginning of +self+.
1002 *
1003 * (1..4).begin # => 1
1004 * (..2).begin # => nil
1005 *
1006 * Related: Range#first, Range#end.
1007 */
1008
1009static VALUE
1010range_begin(VALUE range)
1011{
1012 return RANGE_BEG(range);
1013}
1014
1015
1016/*
1017 * call-seq:
1018 * self.end -> object
1019 *
1020 * Returns the object that defines the end of +self+.
1021 *
1022 * (1..4).end # => 4
1023 * (1...4).end # => 4
1024 * (1..).end # => nil
1025 *
1026 * Related: Range#begin, Range#last.
1027 */
1028
1029
1030static VALUE
1031range_end(VALUE range)
1032{
1033 return RANGE_END(range);
1034}
1035
1036
1037static VALUE
1038first_i(RB_BLOCK_CALL_FUNC_ARGLIST(i, cbarg))
1039{
1040 VALUE *ary = (VALUE *)cbarg;
1041 long n = NUM2LONG(ary[0]);
1042
1043 if (n <= 0) {
1044 rb_iter_break();
1045 }
1046 rb_ary_push(ary[1], i);
1047 n--;
1048 ary[0] = LONG2NUM(n);
1049 return Qnil;
1050}
1051
1052/*
1053 * call-seq:
1054 * first -> object
1055 * first(n) -> array
1056 *
1057 * With no argument, returns the first element of +self+, if it exists:
1058 *
1059 * (1..4).first # => 1
1060 * ('a'..'d').first # => "a"
1061 *
1062 * With non-negative integer argument +n+ given,
1063 * returns the first +n+ elements in an array:
1064 *
1065 * (1..10).first(3) # => [1, 2, 3]
1066 * (1..10).first(0) # => []
1067 * (1..4).first(50) # => [1, 2, 3, 4]
1068 *
1069 * Raises an exception if there is no first element:
1070 *
1071 * (..4).first # Raises RangeError
1072 */
1073
1074static VALUE
1075range_first(int argc, VALUE *argv, VALUE range)
1076{
1077 VALUE n, ary[2];
1078
1079 if (NIL_P(RANGE_BEG(range))) {
1080 rb_raise(rb_eRangeError, "cannot get the first element of beginless range");
1081 }
1082 if (argc == 0) return RANGE_BEG(range);
1083
1084 rb_scan_args(argc, argv, "1", &n);
1085 ary[0] = n;
1086 ary[1] = rb_ary_new2(NUM2LONG(n));
1087 rb_block_call(range, idEach, 0, 0, first_i, (VALUE)ary);
1088
1089 return ary[1];
1090}
1091
1092static VALUE
1093rb_int_range_last(int argc, VALUE *argv, VALUE range)
1094{
1095 static const VALUE ONE = INT2FIX(1);
1096
1097 VALUE b, e, len_1, len, nv, ary;
1098 int x;
1099 long n;
1100
1101 assert(argc > 0);
1102
1103 b = RANGE_BEG(range);
1104 e = RANGE_END(range);
1105 assert(RB_INTEGER_TYPE_P(b) && RB_INTEGER_TYPE_P(e));
1106
1107 x = EXCL(range);
1108
1109 len_1 = rb_int_minus(e, b);
1110 if (x) {
1111 e = rb_int_minus(e, ONE);
1112 len = len_1;
1113 }
1114 else {
1115 len = rb_int_plus(len_1, ONE);
1116 }
1117
1118 if (FIXNUM_ZERO_P(len) || rb_num_negative_p(len)) {
1119 return rb_ary_new_capa(0);
1120 }
1121
1122 rb_scan_args(argc, argv, "1", &nv);
1123 n = NUM2LONG(nv);
1124 if (n < 0) {
1125 rb_raise(rb_eArgError, "negative array size");
1126 }
1127
1128 nv = LONG2NUM(n);
1129 if (RTEST(rb_int_gt(nv, len))) {
1130 nv = len;
1131 n = NUM2LONG(nv);
1132 }
1133
1134 ary = rb_ary_new_capa(n);
1135 b = rb_int_minus(e, nv);
1136 while (n) {
1137 b = rb_int_plus(b, ONE);
1138 rb_ary_push(ary, b);
1139 --n;
1140 }
1141
1142 return ary;
1143}
1144
1145/*
1146 * call-seq:
1147 * last -> object
1148 * last(n) -> array
1149 *
1150 * With no argument, returns the last element of +self+, if it exists:
1151 *
1152 * (1..4).last # => 4
1153 * ('a'..'d').last # => "d"
1154 *
1155 * Note that +last+ with no argument returns the end element of +self+
1156 * even if #exclude_end? is +true+:
1157 *
1158 * (1...4).last # => 4
1159 * ('a'...'d').last # => "d"
1160 *
1161 * With non-negative integer argument +n+ given,
1162 * returns the last +n+ elements in an array:
1163 *
1164 * (1..10).last(3) # => [8, 9, 10]
1165 * (1..10).last(0) # => []
1166 * (1..4).last(50) # => [1, 2, 3, 4]
1167 *
1168 * Note that +last+ with argument does not return the end element of +self+
1169 * if #exclude_end? it +true+:
1170 *
1171 * (1...4).last(3) # => [1, 2, 3]
1172 * ('a'...'d').last(3) # => ["a", "b", "c"]
1173 *
1174 * Raises an exception if there is no last element:
1175 *
1176 * (1..).last # Raises RangeError
1177 *
1178 */
1179
1180static VALUE
1181range_last(int argc, VALUE *argv, VALUE range)
1182{
1183 VALUE b, e;
1184
1185 if (NIL_P(RANGE_END(range))) {
1186 rb_raise(rb_eRangeError, "cannot get the last element of endless range");
1187 }
1188 if (argc == 0) return RANGE_END(range);
1189
1190 b = RANGE_BEG(range);
1191 e = RANGE_END(range);
1192 if (RB_INTEGER_TYPE_P(b) && RB_INTEGER_TYPE_P(e) &&
1194 return rb_int_range_last(argc, argv, range);
1195 }
1196 return rb_ary_last(argc, argv, rb_Array(range));
1197}
1198
1199
1200/*
1201 * call-seq:
1202 * min -> object
1203 * min(n) -> array
1204 * min {|a, b| ... } -> object
1205 * min(n) {|a, b| ... } -> array
1206 *
1207 * Returns the minimum value in +self+,
1208 * using method <tt><=></tt> or a given block for comparison.
1209 *
1210 * With no argument and no block given,
1211 * returns the minimum-valued element of +self+.
1212 *
1213 * (1..4).min # => 1
1214 * ('a'..'d').min # => "a"
1215 * (-4..-1).min # => -4
1216 *
1217 * With non-negative integer argument +n+ given, and no block given,
1218 * returns the +n+ minimum-valued elements of +self+ in an array:
1219 *
1220 * (1..4).min(2) # => [1, 2]
1221 * ('a'..'d').min(2) # => ["a", "b"]
1222 * (-4..-1).min(2) # => [-4, -3]
1223 * (1..4).min(50) # => [1, 2, 3, 4]
1224 *
1225 * If a block is given, it is called:
1226 *
1227 * - First, with the first two element of +self+.
1228 * - Then, sequentially, with the so-far minimum value and the next element of +self+.
1229 *
1230 * To illustrate:
1231 *
1232 * (1..4).min {|a, b| p [a, b]; a <=> b } # => 1
1233 *
1234 * Output:
1235 *
1236 * [2, 1]
1237 * [3, 1]
1238 * [4, 1]
1239 *
1240 * With no argument and a block given,
1241 * returns the return value of the last call to the block:
1242 *
1243 * (1..4).min {|a, b| -(a <=> b) } # => 4
1244 *
1245 * With non-negative integer argument +n+ given, and a block given,
1246 * returns the return values of the last +n+ calls to the block in an array:
1247 *
1248 * (1..4).min(2) {|a, b| -(a <=> b) } # => [4, 3]
1249 * (1..4).min(50) {|a, b| -(a <=> b) } # => [4, 3, 2, 1]
1250 *
1251 * Returns an empty array if +n+ is zero:
1252 *
1253 * (1..4).min(0) # => []
1254 * (1..4).min(0) {|a, b| -(a <=> b) } # => []
1255 *
1256 * Returns +nil+ or an empty array if:
1257 *
1258 * - The begin value of the range is larger than the end value:
1259 *
1260 * (4..1).min # => nil
1261 * (4..1).min(2) # => []
1262 * (4..1).min {|a, b| -(a <=> b) } # => nil
1263 * (4..1).min(2) {|a, b| -(a <=> b) } # => []
1264 *
1265 * - The begin value of an exclusive range is equal to the end value:
1266 *
1267 * (1...1).min # => nil
1268 * (1...1).min(2) # => []
1269 * (1...1).min {|a, b| -(a <=> b) } # => nil
1270 * (1...1).min(2) {|a, b| -(a <=> b) } # => []
1271 *
1272 * Raises an exception if either:
1273 *
1274 * - +self+ is a beginless range: <tt>(..4)</tt>.
1275 * - A block is given and +self+ is an endless range.
1276 *
1277 * Related: Range#max, Range#minmax.
1278 */
1279
1280
1281static VALUE
1282range_min(int argc, VALUE *argv, VALUE range)
1283{
1284 if (NIL_P(RANGE_BEG(range))) {
1285 rb_raise(rb_eRangeError, "cannot get the minimum of beginless range");
1286 }
1287
1288 if (rb_block_given_p()) {
1289 if (NIL_P(RANGE_END(range))) {
1290 rb_raise(rb_eRangeError, "cannot get the minimum of endless range with custom comparison method");
1291 }
1292 return rb_call_super(argc, argv);
1293 }
1294 else if (argc != 0) {
1295 return range_first(argc, argv, range);
1296 }
1297 else {
1298 struct cmp_opt_data cmp_opt = { 0, 0 };
1299 VALUE b = RANGE_BEG(range);
1300 VALUE e = RANGE_END(range);
1301 int c = NIL_P(e) ? -1 : OPTIMIZED_CMP(b, e, cmp_opt);
1302
1303 if (c > 0 || (c == 0 && EXCL(range)))
1304 return Qnil;
1305 return b;
1306 }
1307}
1308
1309/*
1310 * call-seq:
1311 * max -> object
1312 * max(n) -> array
1313 * max {|a, b| ... } -> object
1314 * max(n) {|a, b| ... } -> array
1315 *
1316 * Returns the maximum value in +self+,
1317 * using method <tt><=></tt> or a given block for comparison.
1318 *
1319 * With no argument and no block given,
1320 * returns the maximum-valued element of +self+.
1321 *
1322 * (1..4).max # => 4
1323 * ('a'..'d').max # => "d"
1324 * (-4..-1).max # => -1
1325 *
1326 * With non-negative integer argument +n+ given, and no block given,
1327 * returns the +n+ maximum-valued elements of +self+ in an array:
1328 *
1329 * (1..4).max(2) # => [4, 3]
1330 * ('a'..'d').max(2) # => ["d", "c"]
1331 * (-4..-1).max(2) # => [-1, -2]
1332 * (1..4).max(50) # => [4, 3, 2, 1]
1333 *
1334 * If a block is given, it is called:
1335 *
1336 * - First, with the first two element of +self+.
1337 * - Then, sequentially, with the so-far maximum value and the next element of +self+.
1338 *
1339 * To illustrate:
1340 *
1341 * (1..4).max {|a, b| p [a, b]; a <=> b } # => 4
1342 *
1343 * Output:
1344 *
1345 * [2, 1]
1346 * [3, 2]
1347 * [4, 3]
1348 *
1349 * With no argument and a block given,
1350 * returns the return value of the last call to the block:
1351 *
1352 * (1..4).max {|a, b| -(a <=> b) } # => 1
1353 *
1354 * With non-negative integer argument +n+ given, and a block given,
1355 * returns the return values of the last +n+ calls to the block in an array:
1356 *
1357 * (1..4).max(2) {|a, b| -(a <=> b) } # => [1, 2]
1358 * (1..4).max(50) {|a, b| -(a <=> b) } # => [1, 2, 3, 4]
1359 *
1360 * Returns an empty array if +n+ is zero:
1361 *
1362 * (1..4).max(0) # => []
1363 * (1..4).max(0) {|a, b| -(a <=> b) } # => []
1364 *
1365 * Returns +nil+ or an empty array if:
1366 *
1367 * - The begin value of the range is larger than the end value:
1368 *
1369 * (4..1).max # => nil
1370 * (4..1).max(2) # => []
1371 * (4..1).max {|a, b| -(a <=> b) } # => nil
1372 * (4..1).max(2) {|a, b| -(a <=> b) } # => []
1373 *
1374 * - The begin value of an exclusive range is equal to the end value:
1375 *
1376 * (1...1).max # => nil
1377 * (1...1).max(2) # => []
1378 * (1...1).max {|a, b| -(a <=> b) } # => nil
1379 * (1...1).max(2) {|a, b| -(a <=> b) } # => []
1380 *
1381 * Raises an exception if either:
1382 *
1383 * - +self+ is a endless range: <tt>(1..)</tt>.
1384 * - A block is given and +self+ is a beginless range.
1385 *
1386 * Related: Range#min, Range#minmax.
1387 *
1388 */
1389
1390static VALUE
1391range_max(int argc, VALUE *argv, VALUE range)
1392{
1393 VALUE e = RANGE_END(range);
1394 int nm = FIXNUM_P(e) || rb_obj_is_kind_of(e, rb_cNumeric);
1395
1396 if (NIL_P(RANGE_END(range))) {
1397 rb_raise(rb_eRangeError, "cannot get the maximum of endless range");
1398 }
1399
1400 VALUE b = RANGE_BEG(range);
1401
1402 if (rb_block_given_p() || (EXCL(range) && !nm) || argc) {
1403 if (NIL_P(b)) {
1404 rb_raise(rb_eRangeError, "cannot get the maximum of beginless range with custom comparison method");
1405 }
1406 return rb_call_super(argc, argv);
1407 }
1408 else {
1409 struct cmp_opt_data cmp_opt = { 0, 0 };
1410 int c = NIL_P(b) ? -1 : OPTIMIZED_CMP(b, e, cmp_opt);
1411
1412 if (c > 0)
1413 return Qnil;
1414 if (EXCL(range)) {
1415 if (!RB_INTEGER_TYPE_P(e)) {
1416 rb_raise(rb_eTypeError, "cannot exclude non Integer end value");
1417 }
1418 if (c == 0) return Qnil;
1419 if (!RB_INTEGER_TYPE_P(b)) {
1420 rb_raise(rb_eTypeError, "cannot exclude end value with non Integer begin value");
1421 }
1422 if (FIXNUM_P(e)) {
1423 return LONG2NUM(FIX2LONG(e) - 1);
1424 }
1425 return rb_funcall(e, '-', 1, INT2FIX(1));
1426 }
1427 return e;
1428 }
1429}
1430
1431/*
1432 * call-seq:
1433 * minmax -> [object, object]
1434 * minmax {|a, b| ... } -> [object, object]
1435 *
1436 * Returns a 2-element array containing the minimum and maximum value in +self+,
1437 * either according to comparison method <tt><=></tt> or a given block.
1438 *
1439 * With no block given, returns the minimum and maximum values,
1440 * using <tt><=></tt> for comparison:
1441 *
1442 * (1..4).minmax # => [1, 4]
1443 * (1...4).minmax # => [1, 3]
1444 * ('a'..'d').minmax # => ["a", "d"]
1445 * (-4..-1).minmax # => [-4, -1]
1446 *
1447 * With a block given, the block must return an integer:
1448 *
1449 * - Negative if +a+ is smaller than +b+.
1450 * - Zero if +a+ and +b+ are equal.
1451 * - Positive if +a+ is larger than +b+.
1452 *
1453 * The block is called <tt>self.size</tt> times to compare elements;
1454 * returns a 2-element Array containing the minimum and maximum values from +self+,
1455 * per the block:
1456 *
1457 * (1..4).minmax {|a, b| -(a <=> b) } # => [4, 1]
1458 *
1459 * Returns <tt>[nil, nil]</tt> if:
1460 *
1461 * - The begin value of the range is larger than the end value:
1462 *
1463 * (4..1).minmax # => [nil, nil]
1464 * (4..1).minmax {|a, b| -(a <=> b) } # => [nil, nil]
1465 *
1466 * - The begin value of an exclusive range is equal to the end value:
1467 *
1468 * (1...1).minmax # => [nil, nil]
1469 * (1...1).minmax {|a, b| -(a <=> b) } # => [nil, nil]
1470 *
1471 * Raises an exception if +self+ is a beginless or an endless range.
1472 *
1473 * Related: Range#min, Range#max.
1474 *
1475 */
1476
1477static VALUE
1478range_minmax(VALUE range)
1479{
1480 if (rb_block_given_p()) {
1481 return rb_call_super(0, NULL);
1482 }
1483 return rb_assoc_new(
1484 rb_funcall(range, id_min, 0),
1485 rb_funcall(range, id_max, 0)
1486 );
1487}
1488
1489int
1490rb_range_values(VALUE range, VALUE *begp, VALUE *endp, int *exclp)
1491{
1492 VALUE b, e;
1493 int excl;
1494
1495 if (rb_obj_is_kind_of(range, rb_cRange)) {
1496 b = RANGE_BEG(range);
1497 e = RANGE_END(range);
1498 excl = EXCL(range);
1499 }
1500 else if (RTEST(rb_obj_is_kind_of(range, rb_cArithSeq))) {
1501 return (int)Qfalse;
1502 }
1503 else {
1504 VALUE x;
1505 b = rb_check_funcall(range, id_beg, 0, 0);
1506 if (b == Qundef) return (int)Qfalse;
1507 e = rb_check_funcall(range, id_end, 0, 0);
1508 if (e == Qundef) return (int)Qfalse;
1509 x = rb_check_funcall(range, rb_intern("exclude_end?"), 0, 0);
1510 if (x == Qundef) return (int)Qfalse;
1511 excl = RTEST(x);
1512 }
1513 *begp = b;
1514 *endp = e;
1515 *exclp = excl;
1516 return (int)Qtrue;
1517}
1518
1519/* Extract the components of a Range.
1520 *
1521 * You can use +err+ to control the behavior of out-of-range and exception.
1522 *
1523 * When +err+ is 0 or 2, if the begin offset is greater than +len+,
1524 * it is out-of-range. The +RangeError+ is raised only if +err+ is 2,
1525 * in this case. If +err+ is 0, +Qnil+ will be returned.
1526 *
1527 * When +err+ is 1, the begin and end offsets won't be adjusted even if they
1528 * are greater than +len+. It allows +rb_ary_aset+ extends arrays.
1529 *
1530 * If the begin component of the given range is negative and is too-large
1531 * abstract value, the +RangeError+ is raised only +err+ is 1 or 2.
1532 *
1533 * The case of <code>err = 0</code> is used in item accessing methods such as
1534 * +rb_ary_aref+, +rb_ary_slice_bang+, and +rb_str_aref+.
1535 *
1536 * The case of <code>err = 1</code> is used in Array's methods such as
1537 * +rb_ary_aset+ and +rb_ary_fill+.
1538 *
1539 * The case of <code>err = 2</code> is used in +rb_str_aset+.
1540 */
1541VALUE
1542rb_range_component_beg_len(VALUE b, VALUE e, int excl,
1543 long *begp, long *lenp, long len, int err)
1544{
1545 long beg, end;
1546
1547 beg = NIL_P(b) ? 0 : NUM2LONG(b);
1548 end = NIL_P(e) ? -1 : NUM2LONG(e);
1549 if (NIL_P(e)) excl = 0;
1550 if (beg < 0) {
1551 beg += len;
1552 if (beg < 0)
1553 goto out_of_range;
1554 }
1555 if (end < 0)
1556 end += len;
1557 if (!excl)
1558 end++; /* include end point */
1559 if (err == 0 || err == 2) {
1560 if (beg > len)
1561 goto out_of_range;
1562 if (end > len)
1563 end = len;
1564 }
1565 len = end - beg;
1566 if (len < 0)
1567 len = 0;
1568
1569 *begp = beg;
1570 *lenp = len;
1571 return Qtrue;
1572
1573 out_of_range:
1574 return Qnil;
1575}
1576
1577VALUE
1578rb_range_beg_len(VALUE range, long *begp, long *lenp, long len, int err)
1579{
1580 VALUE b, e;
1581 int excl;
1582
1583 if (!rb_range_values(range, &b, &e, &excl))
1584 return Qfalse;
1585
1586 VALUE res = rb_range_component_beg_len(b, e, excl, begp, lenp, len, err);
1587 if (NIL_P(res) && err) {
1588 rb_raise(rb_eRangeError, "%+"PRIsVALUE" out of range", range);
1589 }
1590
1591 return res;
1592}
1593
1594/*
1595 * call-seq:
1596 * to_s -> string
1597 *
1598 * Returns a string representation of +self+,
1599 * including <tt>begin.to_s</tt> and <tt>end.to_s</tt>:
1600 *
1601 * (1..4).to_s # => "1..4"
1602 * (1...4).to_s # => "1...4"
1603 * (1..).to_s # => "1.."
1604 * (..4).to_s # => "..4"
1605 *
1606 * Note that returns from #to_s and #inspect may differ:
1607 *
1608 * ('a'..'d').to_s # => "a..d"
1609 * ('a'..'d').inspect # => "\"a\"..\"d\""
1610 *
1611 * Related: Range#inspect.
1612 *
1613 */
1614
1615static VALUE
1616range_to_s(VALUE range)
1617{
1618 VALUE str, str2;
1619
1620 str = rb_obj_as_string(RANGE_BEG(range));
1621 str2 = rb_obj_as_string(RANGE_END(range));
1622 str = rb_str_dup(str);
1623 rb_str_cat(str, "...", EXCL(range) ? 3 : 2);
1624 rb_str_append(str, str2);
1625
1626 return str;
1627}
1628
1629static VALUE
1630inspect_range(VALUE range, VALUE dummy, int recur)
1631{
1632 VALUE str, str2 = Qundef;
1633
1634 if (recur) {
1635 return rb_str_new2(EXCL(range) ? "(... ... ...)" : "(... .. ...)");
1636 }
1637 if (!NIL_P(RANGE_BEG(range)) || NIL_P(RANGE_END(range))) {
1638 str = rb_str_dup(rb_inspect(RANGE_BEG(range)));
1639 }
1640 else {
1641 str = rb_str_new(0, 0);
1642 }
1643 rb_str_cat(str, "...", EXCL(range) ? 3 : 2);
1644 if (NIL_P(RANGE_BEG(range)) || !NIL_P(RANGE_END(range))) {
1645 str2 = rb_inspect(RANGE_END(range));
1646 }
1647 if (str2 != Qundef) rb_str_append(str, str2);
1648
1649 return str;
1650}
1651
1652/*
1653 * call-seq:
1654 * inspect -> string
1655 *
1656 * Returns a string representation of +self+,
1657 * including <tt>begin.inspect</tt> and <tt>end.inspect</tt>:
1658 *
1659 * (1..4).inspect # => "1..4"
1660 * (1...4).inspect # => "1...4"
1661 * (1..).inspect # => "1.."
1662 * (..4).inspect # => "..4"
1663 *
1664 * Note that returns from #to_s and #inspect may differ:
1665 *
1666 * ('a'..'d').to_s # => "a..d"
1667 * ('a'..'d').inspect # => "\"a\"..\"d\""
1668 *
1669 * Related: Range#to_s.
1670 *
1671 */
1672
1673
1674static VALUE
1675range_inspect(VALUE range)
1676{
1677 return rb_exec_recursive(inspect_range, range, 0);
1678}
1679
1680static VALUE range_include_internal(VALUE range, VALUE val, int string_use_cover);
1681
1682/*
1683 * call-seq:
1684 * self === object -> true or false
1685 *
1686 * Returns +true+ if +object+ is between <tt>self.begin</tt> and <tt>self.end</tt>.
1687 * +false+ otherwise:
1688 *
1689 * (1..4) === 2 # => true
1690 * (1..4) === 5 # => false
1691 * (1..4) === 'a' # => false
1692 * (1..4) === 4 # => true
1693 * (1...4) === 4 # => false
1694 * ('a'..'d') === 'c' # => true
1695 * ('a'..'d') === 'e' # => false
1696 *
1697 * A case statement uses method <tt>===</tt>, and so:
1698 *
1699 * case 79
1700 * when (1..50)
1701 * "low"
1702 * when (51..75)
1703 * "medium"
1704 * when (76..100)
1705 * "high"
1706 * end # => "high"
1707 *
1708 * case "2.6.5"
1709 * when ..."2.4"
1710 * "EOL"
1711 * when "2.4"..."2.5"
1712 * "maintenance"
1713 * when "2.5"..."3.0"
1714 * "stable"
1715 * when "3.1"..
1716 * "upcoming"
1717 * end # => "stable"
1718 *
1719 */
1720
1721static VALUE
1722range_eqq(VALUE range, VALUE val)
1723{
1724 VALUE ret = range_include_internal(range, val, 1);
1725 if (ret != Qundef) return ret;
1726 return r_cover_p(range, RANGE_BEG(range), RANGE_END(range), val);
1727}
1728
1729
1730/*
1731 * call-seq:
1732 * include?(object) -> true or false
1733 *
1734 * Returns +true+ if +object+ is an element of +self+, +false+ otherwise:
1735 *
1736 * (1..4).include?(2) # => true
1737 * (1..4).include?(5) # => false
1738 * (1..4).include?(4) # => true
1739 * (1...4).include?(4) # => false
1740 * ('a'..'d').include?('b') # => true
1741 * ('a'..'d').include?('e') # => false
1742 * ('a'..'d').include?('B') # => false
1743 * ('a'..'d').include?('d') # => true
1744 * ('a'...'d').include?('d') # => false
1745 *
1746 * If begin and end are numeric, #include? behaves like #cover?
1747 *
1748 * (1..3).include?(1.5) # => true
1749 * (1..3).cover?(1.5) # => true
1750 *
1751 * But when not numeric, the two methods may differ:
1752 *
1753 * ('a'..'d').include?('cc') # => false
1754 * ('a'..'d').cover?('cc') # => true
1755 *
1756 * Related: Range#cover?.
1757 *
1758 * Range#member? is an alias for Range#include?.
1759 */
1760
1761static VALUE
1762range_include(VALUE range, VALUE val)
1763{
1764 VALUE ret = range_include_internal(range, val, 0);
1765 if (ret != Qundef) return ret;
1766 return rb_call_super(1, &val);
1767}
1768
1769static VALUE
1770range_include_internal(VALUE range, VALUE val, int string_use_cover)
1771{
1772 VALUE beg = RANGE_BEG(range);
1773 VALUE end = RANGE_END(range);
1774 int nv = FIXNUM_P(beg) || FIXNUM_P(end) ||
1775 linear_object_p(beg) || linear_object_p(end);
1776
1777 if (nv ||
1778 !NIL_P(rb_check_to_integer(beg, "to_int")) ||
1779 !NIL_P(rb_check_to_integer(end, "to_int"))) {
1780 return r_cover_p(range, beg, end, val);
1781 }
1782 else if (RB_TYPE_P(beg, T_STRING) || RB_TYPE_P(end, T_STRING)) {
1783 if (RB_TYPE_P(beg, T_STRING) && RB_TYPE_P(end, T_STRING)) {
1784 if (string_use_cover) {
1785 return r_cover_p(range, beg, end, val);
1786 }
1787 else {
1788 VALUE rb_str_include_range_p(VALUE beg, VALUE end, VALUE val, VALUE exclusive);
1789 return rb_str_include_range_p(beg, end, val, RANGE_EXCL(range));
1790 }
1791 }
1792 else if (NIL_P(beg)) {
1793 VALUE r = rb_funcall(val, id_cmp, 1, end);
1794 if (NIL_P(r)) return Qfalse;
1795 return RBOOL(rb_cmpint(r, val, end) <= 0);
1796 }
1797 else if (NIL_P(end)) {
1798 VALUE r = rb_funcall(beg, id_cmp, 1, val);
1799 if (NIL_P(r)) return Qfalse;
1800 return RBOOL(rb_cmpint(r, beg, val) <= 0);
1801 }
1802 }
1803 return Qundef;
1804}
1805
1806static int r_cover_range_p(VALUE range, VALUE beg, VALUE end, VALUE val);
1807
1808/*
1809 * call-seq:
1810 * cover?(object) -> true or false
1811 * cover?(range) -> true or false
1812 *
1813 * Returns +true+ if the given argument is within +self+, +false+ otherwise.
1814 *
1815 * With non-range argument +object+, evaluates with <tt><=</tt> and <tt><</tt>.
1816 *
1817 * For range +self+ with included end value (<tt>#exclude_end? == false</tt>),
1818 * evaluates thus:
1819 *
1820 * self.begin <= object <= self.end
1821 *
1822 * Examples:
1823 *
1824 * r = (1..4)
1825 * r.cover?(1) # => true
1826 * r.cover?(4) # => true
1827 * r.cover?(0) # => false
1828 * r.cover?(5) # => false
1829 * r.cover?('foo') # => false
1830
1831 * r = ('a'..'d')
1832 * r.cover?('a') # => true
1833 * r.cover?('d') # => true
1834 * r.cover?(' ') # => false
1835 * r.cover?('e') # => false
1836 * r.cover?(0) # => false
1837 *
1838 * For range +r+ with excluded end value (<tt>#exclude_end? == true</tt>),
1839 * evaluates thus:
1840 *
1841 * r.begin <= object < r.end
1842 *
1843 * Examples:
1844 *
1845 * r = (1...4)
1846 * r.cover?(1) # => true
1847 * r.cover?(3) # => true
1848 * r.cover?(0) # => false
1849 * r.cover?(4) # => false
1850 * r.cover?('foo') # => false
1851
1852 * r = ('a'...'d')
1853 * r.cover?('a') # => true
1854 * r.cover?('c') # => true
1855 * r.cover?(' ') # => false
1856 * r.cover?('d') # => false
1857 * r.cover?(0) # => false
1858 *
1859 * With range argument +range+, compares the first and last
1860 * elements of +self+ and +range+:
1861 *
1862 * r = (1..4)
1863 * r.cover?(1..4) # => true
1864 * r.cover?(0..4) # => false
1865 * r.cover?(1..5) # => false
1866 * r.cover?('a'..'d') # => false
1867
1868 * r = (1...4)
1869 * r.cover?(1..3) # => true
1870 * r.cover?(1..4) # => false
1871 *
1872 * If begin and end are numeric, #cover? behaves like #include?
1873 *
1874 * (1..3).cover?(1.5) # => true
1875 * (1..3).include?(1.5) # => true
1876 *
1877 * But when not numeric, the two methods may differ:
1878 *
1879 * ('a'..'d').cover?('cc') # => true
1880 * ('a'..'d').include?('cc') # => false
1881 *
1882 * Returns +false+ if either:
1883 *
1884 * - The begin value of +self+ is larger than its end value.
1885 * - An internal call to <tt><=></tt> returns +nil+;
1886 * that is, the operands are not comparable.
1887 *
1888 * Related: Range#include?.
1889 *
1890 */
1891
1892static VALUE
1893range_cover(VALUE range, VALUE val)
1894{
1895 VALUE beg, end;
1896
1897 beg = RANGE_BEG(range);
1898 end = RANGE_END(range);
1899
1900 if (rb_obj_is_kind_of(val, rb_cRange)) {
1901 return RBOOL(r_cover_range_p(range, beg, end, val));
1902 }
1903 return r_cover_p(range, beg, end, val);
1904}
1905
1906static VALUE
1907r_call_max(VALUE r)
1908{
1909 return rb_funcallv(r, rb_intern("max"), 0, 0);
1910}
1911
1912static int
1913r_cover_range_p(VALUE range, VALUE beg, VALUE end, VALUE val)
1914{
1915 VALUE val_beg, val_end, val_max;
1916 int cmp_end;
1917
1918 val_beg = RANGE_BEG(val);
1919 val_end = RANGE_END(val);
1920
1921 if (!NIL_P(end) && NIL_P(val_end)) return FALSE;
1922 if (!NIL_P(beg) && NIL_P(val_beg)) return FALSE;
1923 if (!NIL_P(val_beg) && !NIL_P(val_end) && r_less(val_beg, val_end) > (EXCL(val) ? -1 : 0)) return FALSE;
1924 if (!NIL_P(val_beg) && !r_cover_p(range, beg, end, val_beg)) return FALSE;
1925
1926 cmp_end = r_less(end, val_end);
1927
1928 if (EXCL(range) == EXCL(val)) {
1929 return cmp_end >= 0;
1930 }
1931 else if (EXCL(range)) {
1932 return cmp_end > 0;
1933 }
1934 else if (cmp_end >= 0) {
1935 return TRUE;
1936 }
1937
1938 val_max = rb_rescue2(r_call_max, val, 0, Qnil, rb_eTypeError, (VALUE)0);
1939 if (NIL_P(val_max)) return FALSE;
1940
1941 return r_less(end, val_max) >= 0;
1942}
1943
1944static VALUE
1945r_cover_p(VALUE range, VALUE beg, VALUE end, VALUE val)
1946{
1947 if (NIL_P(beg) || r_less(beg, val) <= 0) {
1948 int excl = EXCL(range);
1949 if (NIL_P(end) || r_less(val, end) <= -excl)
1950 return Qtrue;
1951 }
1952 return Qfalse;
1953}
1954
1955static VALUE
1956range_dumper(VALUE range)
1957{
1958 VALUE v = rb_obj_alloc(rb_cObject);
1959
1960 rb_ivar_set(v, id_excl, RANGE_EXCL(range));
1961 rb_ivar_set(v, id_beg, RANGE_BEG(range));
1962 rb_ivar_set(v, id_end, RANGE_END(range));
1963 return v;
1964}
1965
1966static VALUE
1967range_loader(VALUE range, VALUE obj)
1968{
1969 VALUE beg, end, excl;
1970
1971 if (!RB_TYPE_P(obj, T_OBJECT) || RBASIC(obj)->klass != rb_cObject) {
1972 rb_raise(rb_eTypeError, "not a dumped range object");
1973 }
1974
1975 range_modify(range);
1976 beg = rb_ivar_get(obj, id_beg);
1977 end = rb_ivar_get(obj, id_end);
1978 excl = rb_ivar_get(obj, id_excl);
1979 if (!NIL_P(excl)) {
1980 range_init(range, beg, end, RBOOL(RTEST(excl)));
1981 }
1982 return range;
1983}
1984
1985static VALUE
1986range_alloc(VALUE klass)
1987{
1988 /* rb_struct_alloc_noinit itself should not be used because
1989 * rb_marshal_define_compat uses equality of allocation function */
1990 return rb_struct_alloc_noinit(klass);
1991}
1992
1993/*
1994 * call-seq:
1995 * count -> integer
1996 * count(object) -> integer
1997 * count {|element| ... } -> integer
1998 *
1999 * Returns the count of elements, based on an argument or block criterion, if given.
2000 *
2001 * With no argument and no block given, returns the number of elements:
2002 *
2003 * (1..4).count # => 4
2004 * (1...4).count # => 3
2005 * ('a'..'d').count # => 4
2006 * ('a'...'d').count # => 3
2007 * (1..).count # => Infinity
2008 * (..4).count # => Infinity
2009 *
2010 * With argument +object+, returns the number of +object+ found in +self+,
2011 * which will usually be zero or one:
2012 *
2013 * (1..4).count(2) # => 1
2014 * (1..4).count(5) # => 0
2015 * (1..4).count('a') # => 0
2016 *
2017 * With a block given, calls the block with each element;
2018 * returns the number of elements for which the block returns a truthy value:
2019 *
2020 * (1..4).count {|element| element < 3 } # => 2
2021 *
2022 * Related: Range#size.
2023 */
2024static VALUE
2025range_count(int argc, VALUE *argv, VALUE range)
2026{
2027 if (argc != 0) {
2028 /* It is odd for instance (1...).count(0) to return Infinity. Just let
2029 * it loop. */
2030 return rb_call_super(argc, argv);
2031 }
2032 else if (rb_block_given_p()) {
2033 /* Likewise it is odd for instance (1...).count {|x| x == 0 } to return
2034 * Infinity. Just let it loop. */
2035 return rb_call_super(argc, argv);
2036 }
2037 else if (NIL_P(RANGE_END(range))) {
2038 /* We are confident that the answer is Infinity. */
2039 return DBL2NUM(HUGE_VAL);
2040 }
2041 else if (NIL_P(RANGE_BEG(range))) {
2042 /* We are confident that the answer is Infinity. */
2043 return DBL2NUM(HUGE_VAL);
2044 }
2045 else {
2046 return rb_call_super(argc, argv);
2047 }
2048}
2049
2050/* A \Range object represents a collection of values
2051 * that are between given begin and end values.
2052 *
2053 * You can create an \Range object explicitly with:
2054 *
2055 * - A {range literal}[doc/syntax/literals_rdoc.html#label-Range+Literals]:
2056 *
2057 * # Ranges that use '..' to include the given end value.
2058 * (1..4).to_a # => [1, 2, 3, 4]
2059 * ('a'..'d').to_a # => ["a", "b", "c", "d"]
2060 * # Ranges that use '...' to exclude the given end value.
2061 * (1...4).to_a # => [1, 2, 3]
2062 * ('a'...'d').to_a # => ["a", "b", "c"]
2063 *
2064 * A range may be created using method Range.new:
2065 *
2066 * # Ranges that by default include the given end value.
2067 * Range.new(1, 4).to_a # => [1, 2, 3, 4]
2068 * Range.new('a', 'd').to_a # => ["a", "b", "c", "d"]
2069 * # Ranges that use third argument +exclude_end+ to exclude the given end value.
2070 * Range.new(1, 4, true).to_a # => [1, 2, 3]
2071 * Range.new('a', 'd', true).to_a # => ["a", "b", "c"]
2072 *
2073 * == Beginless Ranges
2074 *
2075 * A _beginless_ _range_ has a definite end value, but a +nil+ begin value.
2076 * Such a range includes all values up to the end value.
2077 *
2078 * r = (..4) # => nil..4
2079 * r.begin # => nil
2080 * r.include?(-50) # => true
2081 * r.include?(4) # => true
2082 *
2083 * r = (...4) # => nil...4
2084 * r.include?(4) # => false
2085 *
2086 * Range.new(nil, 4) # => nil..4
2087 * Range.new(nil, 4, true) # => nil...4
2088 *
2089 * A beginless range may be used to slice an array:
2090 *
2091 * a = [1, 2, 3, 4]
2092 * r = (..2) # => nil...2
2093 * a[r] # => [1, 2]
2094 *
2095 * \Method +each+ for a beginless range raises an exception.
2096 *
2097 * == Endless Ranges
2098 *
2099 * An _endless_ _range_ has a definite begin value, but a +nil+ end value.
2100 * Such a range includes all values from the begin value.
2101 *
2102 * r = (1..) # => 1..
2103 * r.end # => nil
2104 * r.include?(50) # => true
2105 *
2106 * Range.new(1, nil) # => 1..
2107 *
2108 * The literal for an endless range may be written with either two dots
2109 * or three.
2110 * The range has the same elements, either way.
2111 * But note that the two are not equal:
2112 *
2113 * r0 = (1..) # => 1..
2114 * r1 = (1...) # => 1...
2115 * r0.begin == r1.begin # => true
2116 * r0.end == r1.end # => true
2117 * r0 == r1 # => false
2118 *
2119 * An endless range may be used to slice an array:
2120 *
2121 * a = [1, 2, 3, 4]
2122 * r = (2..) # => 2..
2123 * a[r] # => [3, 4]
2124 *
2125 * \Method +each+ for an endless range calls the given block indefinitely:
2126 *
2127 * a = []
2128 * r = (1..)
2129 * r.each do |i|
2130 * a.push(i) if i.even?
2131 * break if i > 10
2132 * end
2133 * a # => [2, 4, 6, 8, 10]
2134 *
2135 * == Ranges and Other Classes
2136 *
2137 * An object may be put into a range if its class implements
2138 * instance method <tt><=></tt>.
2139 * Ruby core classes that do so include Array, Complex, File::Stat,
2140 * Float, Integer, Kernel, Module, Numeric, Rational, String, Symbol, and Time.
2141 *
2142 * Example:
2143 *
2144 * t0 = Time.now # => 2021-09-19 09:22:48.4854986 -0500
2145 * t1 = Time.now # => 2021-09-19 09:22:56.0365079 -0500
2146 * t2 = Time.now # => 2021-09-19 09:23:08.5263283 -0500
2147 * (t0..t2).include?(t1) # => true
2148 * (t0..t1).include?(t2) # => false
2149 *
2150 * A range can be iterated over only if its elements
2151 * implement instance method +succ+.
2152 * Ruby core classes that do so include Integer, String, and Symbol
2153 * (but not the other classes mentioned above).
2154 *
2155 * Iterator methods include:
2156 *
2157 * - In \Range itself: #each, #step, and #%
2158 * - Included from module Enumerable: #each_entry, #each_with_index,
2159 * #each_with_object, #each_slice, #each_cons, and #reverse_each.
2160 *
2161 * Example:
2162 *
2163 * a = []
2164 * (1..4).each {|i| a.push(i) }
2165 * a # => [1, 2, 3, 4]
2166 *
2167 * == Ranges and User-Defined Classes
2168 *
2169 * A user-defined class that is to be used in a range
2170 * must implement instance <tt><=></tt>;
2171 * see {Integer#<=>}[Integer.html#label-method-i-3C-3D-3E].
2172 * To make iteration available, it must also implement
2173 * instance method +succ+; see Integer#succ.
2174 *
2175 * The class below implements both <tt><=></tt> and +succ+,
2176 * and so can be used both to construct ranges and to iterate over them.
2177 * Note that the Comparable module is included
2178 * so the <tt>==</tt> method is defined in terms of <tt><=></tt>.
2179 *
2180 * # Represent a string of 'X' characters.
2181 * class Xs
2182 * include Comparable
2183 * attr_accessor :length
2184 * def initialize(n)
2185 * @length = n
2186 * end
2187 * def succ
2188 * Xs.new(@length + 1)
2189 * end
2190 * def <=>(other)
2191 * @length <=> other.length
2192 * end
2193 * def to_s
2194 * sprintf "%2d #{inspect}", @length
2195 * end
2196 * def inspect
2197 * 'X' * @length
2198 * end
2199 * end
2200 *
2201 * r = Xs.new(3)..Xs.new(6) #=> XXX..XXXXXX
2202 * r.to_a #=> [XXX, XXXX, XXXXX, XXXXXX]
2203 * r.include?(Xs.new(5)) #=> true
2204 * r.include?(Xs.new(7)) #=> false
2205 *
2206 * == What's Here
2207 *
2208 * First, what's elsewhere. \Class \Range:
2209 *
2210 * - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
2211 * - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
2212 * which provides dozens of additional methods.
2213 *
2214 * Here, class \Range provides methods that are useful for:
2215 *
2216 * - {Creating a Range}[#class-Range-label-Methods+for+Creating+a+Range]
2217 * - {Querying}[#class-Range-label-Methods+for+Querying]
2218 * - {Comparing}[#class-Range-label-Methods+for+Comparing]
2219 * - {Iterating}[#class-Range-label-Methods+for+Iterating]
2220 * - {Converting}[#class-Range-label-Methods+for+Converting]
2221 *
2222 * === Methods for Creating a \Range
2223 *
2224 * - ::new:: Returns a new range.
2225 *
2226 * === Methods for Querying
2227 *
2228 * - #begin:: Returns the begin value given for +self+.
2229 * - #bsearch:: Returns an element from +self+ selected by a binary search.
2230 * - #count:: Returns a count of elements in +self+.
2231 * - #end:: Returns the end value given for +self+.
2232 * - #exclude_end?:: Returns whether the end object is excluded.
2233 * - #first:: Returns the first elements of +self+.
2234 * - #hash:: Returns the integer hash code.
2235 * - #last:: Returns the last elements of +self+.
2236 * - #max:: Returns the maximum values in +self+.
2237 * - #min:: Returns the minimum values in +self+.
2238 * - #minmax:: Returns the minimum and maximum values in +self+.
2239 * - #size:: Returns the count of elements in +self+.
2240 *
2241 * === Methods for Comparing
2242 *
2243 * - {#==}[#method-i-3D-3D]:: Returns whether a given object is equal to +self+
2244 * (uses #==).
2245 * - #===:: Returns whether the given object is between the begin and end values.
2246 * - #cover?:: Returns whether a given object is within +self+.
2247 * - #eql?:: Returns whether a given object is equal to +self+ (uses #eql?).
2248 * - #include? (aliased as #member?):: Returns whether a given object
2249 * is an element of +self+.
2250 *
2251 * === Methods for Iterating
2252 *
2253 * - #%:: Requires argument +n+; calls the block with each +n+-th element of +self+.
2254 * - #each:: Calls the block with each element of +self+.
2255 * - #step:: Takes optional argument +n+ (defaults to 1);
2256 calls the block with each +n+-th element of +self+.
2257 *
2258 * === Methods for Converting
2259 *
2260 * - #inspect:: Returns a string representation of +self+ (uses #inspect).
2261 * - #to_a (aliased as #entries):: Returns elements of +self+ in an array.
2262 * - #to_s:: Returns a string representation of +self+ (uses #to_s).
2263 *
2264 */
2265
2266void
2267Init_Range(void)
2268{
2269 id_beg = rb_intern_const("begin");
2270 id_end = rb_intern_const("end");
2271 id_excl = rb_intern_const("excl");
2272
2274 "Range", rb_cObject, range_alloc,
2275 "begin", "end", "excl", NULL);
2276
2278 rb_marshal_define_compat(rb_cRange, rb_cObject, range_dumper, range_loader);
2279 rb_define_method(rb_cRange, "initialize", range_initialize, -1);
2280 rb_define_method(rb_cRange, "initialize_copy", range_initialize_copy, 1);
2281 rb_define_method(rb_cRange, "==", range_eq, 1);
2282 rb_define_method(rb_cRange, "===", range_eqq, 1);
2283 rb_define_method(rb_cRange, "eql?", range_eql, 1);
2284 rb_define_method(rb_cRange, "hash", range_hash, 0);
2285 rb_define_method(rb_cRange, "each", range_each, 0);
2286 rb_define_method(rb_cRange, "step", range_step, -1);
2287 rb_define_method(rb_cRange, "%", range_percent_step, 1);
2288 rb_define_method(rb_cRange, "bsearch", range_bsearch, 0);
2289 rb_define_method(rb_cRange, "begin", range_begin, 0);
2290 rb_define_method(rb_cRange, "end", range_end, 0);
2291 rb_define_method(rb_cRange, "first", range_first, -1);
2292 rb_define_method(rb_cRange, "last", range_last, -1);
2293 rb_define_method(rb_cRange, "min", range_min, -1);
2294 rb_define_method(rb_cRange, "max", range_max, -1);
2295 rb_define_method(rb_cRange, "minmax", range_minmax, 0);
2296 rb_define_method(rb_cRange, "size", range_size, 0);
2297 rb_define_method(rb_cRange, "to_a", range_to_a, 0);
2298 rb_define_method(rb_cRange, "entries", range_to_a, 0);
2299 rb_define_method(rb_cRange, "to_s", range_to_s, 0);
2300 rb_define_method(rb_cRange, "inspect", range_inspect, 0);
2301
2302 rb_define_method(rb_cRange, "exclude_end?", range_exclude_end_p, 0);
2303
2304 rb_define_method(rb_cRange, "member?", range_include, 1);
2305 rb_define_method(rb_cRange, "include?", range_include, 1);
2306 rb_define_method(rb_cRange, "cover?", range_cover, 1);
2307 rb_define_method(rb_cRange, "count", range_count, -1);
2308}
#define RB_LIKELY(x)
Asserts that the given Boolean expression likely holds.
Definition: assume.h:45
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
Definition: class.c:1043
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
Definition: class.c:2406
void rb_define_method(VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
Defines a method.
Definition: class.c:1914
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition: eval.c:850
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition: string.h:1738
#define RB_INTEGER_TYPE_P
Old name of rb_integer_type_p.
Definition: value_type.h:87
#define RFLOAT_VALUE
Old name of rb_float_value.
Definition: double.h:28
#define T_STRING
Old name of RUBY_T_STRING.
Definition: value_type.h:78
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition: long.h:48
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
Definition: assume.h:30
#define T_FLOAT
Old name of RUBY_T_FLOAT.
Definition: value_type.h:64
#define ID2SYM
Old name of RB_ID2SYM.
Definition: symbol.h:44
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
Definition: value_type.h:57
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define CLASS_OF
Old name of rb_class_of.
Definition: globals.h:203
#define FIXABLE
Old name of RB_FIXABLE.
Definition: fixnum.h:25
#define LONG2FIX
Old name of RB_INT2FIX.
Definition: long.h:49
#define ASSUME
Old name of RBIMPL_ASSUME.
Definition: assume.h:29
#define LONG2NUM
Old name of RB_LONG2NUM.
Definition: long.h:50
#define FLONUM_P
Old name of RB_FLONUM_P.
#define Qtrue
Old name of RUBY_Qtrue.
#define ST2FIX
Old name of RB_ST2FIX.
Definition: st_data_t.h:33
#define INT2NUM
Old name of RB_INT2NUM.
Definition: int.h:43
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define FIX2LONG
Old name of RB_FIX2LONG.
Definition: long.h:46
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition: value_type.h:75
#define NIL_P
Old name of RB_NIL_P.
#define POSFIXABLE
Old name of RB_POSFIXABLE.
Definition: fixnum.h:29
#define DBL2NUM
Old name of rb_float_new.
Definition: double.h:29
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition: value_type.h:85
#define NUM2LONG
Old name of RB_NUM2LONG.
Definition: long.h:51
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define CONST_ID
Old name of RUBY_CONST_ID.
Definition: symbol.h:47
#define rb_ary_new2
Old name of rb_ary_new_capa.
Definition: array.h:651
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition: value_type.h:88
void rb_raise(VALUE exc, const char *fmt,...)
Exception entry point.
Definition: error.c:3021
VALUE rb_rescue2(VALUE(*b_proc)(VALUE), VALUE data1, VALUE(*r_proc)(VALUE, VALUE), VALUE data2,...)
An equivalent of rescue clause.
Definition: eval.c:879
void rb_iter_break(void)
Breaks from a block.
Definition: vm.c:1821
VALUE rb_cTime
Time class.
Definition: time.c:647
VALUE rb_mEnumerable
Enumerable module.
Definition: enum.c:27
VALUE rb_cNumeric
Numeric class.
Definition: numeric.c:190
VALUE rb_cRange
Range class.
Definition: range.c:31
VALUE rb_check_to_integer(VALUE val, const char *mid)
Identical to rb_check_convert_type(), except the return value type is fixed to rb_cInteger.
Definition: object.c:2985
#define RUBY_FIXNUM_MAX
Maximum possible value that a fixnum can represent.
Definition: fixnum.h:55
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition: vm_eval.c:1102
VALUE rb_funcallv(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcall(), except it takes the method arguments as a C array.
Definition: vm_eval.c:1061
VALUE rb_call_super(int argc, const VALUE *argv)
This resembles ruby's super.
Definition: vm_eval.c:338
VALUE rb_ary_new_capa(long capa)
Identical to rb_ary_new(), except it additionally specifies how many rooms of objects it should alloc...
Definition: array.c:744
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
Definition: array.c:1308
VALUE rb_assoc_new(VALUE car, VALUE cdr)
Identical to rb_ary_new_from_values(), except it expects exactly two parameters.
Definition: array.c:976
VALUE rb_big_plus(VALUE x, VALUE y)
Performs addition of the passed two objects.
Definition: bignum.c:5821
VALUE rb_big_cmp(VALUE lhs, VALUE rhs)
Compares the passed two bignums.
Definition: bignum.c:5418
int rb_cmpint(VALUE val, VALUE a, VALUE b)
Canonicalises the passed val, which is the return value of a <=> b, into C's {-1, 0,...
Definition: bignum.c:2935
#define RETURN_SIZED_ENUMERATOR(obj, argc, argv, size_fn)
This roughly resembles return enum_for(__callee__) unless block_given?.
Definition: enumerator.h:206
#define RETURN_ENUMERATOR(obj, argc, argv)
Identical to RETURN_SIZED_ENUMERATOR(), except its size is unknown.
Definition: enumerator.h:239
#define rb_check_frozen
Just another name of rb_check_frozen.
Definition: error.h:278
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition: error.h:294
ID rb_frame_this_func(void)
Queries the name of the Ruby level method that is calling this function.
Definition: eval.c:1035
VALUE rb_hash(VALUE obj)
Calculates a message authentication code of the passed object.
Definition: hash.c:227
int rb_range_values(VALUE range, VALUE *begp, VALUE *endp, int *exclp)
Deconstructs a range into its components.
Definition: range.c:1490
VALUE rb_range_new(VALUE beg, VALUE end, int excl)
Creates a new Range.
Definition: range.c:67
VALUE rb_range_beg_len(VALUE range, long *begp, long *lenp, long len, int err)
Deconstructs a numerical range.
Definition: range.c:1578
#define rb_hash_uint(h, i)
Just another name of st_hash_uint.
Definition: string.h:973
#define rb_hash_end(h)
Just another name of st_hash_end.
Definition: string.h:976
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition: string.c:3317
VALUE rb_str_dup(VALUE str)
Duplicates a string.
Definition: string.c:1808
VALUE rb_str_cat(VALUE dst, const char *src, long srclen)
Destructively appends the passed contents to the string.
Definition: string.c:3161
st_index_t rb_hash_start(st_index_t i)
Starts a series of hashing.
Definition: random.c:1714
VALUE rb_str_new(const char *ptr, long len)
Allocates an instance of rb_cString.
Definition: string.c:918
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
Definition: string.c:2659
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition: symbol.c:837
VALUE rb_obj_as_string(VALUE obj)
Try converting an object to its stringised representation using its to_s method, if any.
Definition: string.c:1657
VALUE rb_struct_define_without_accessor(const char *name, VALUE super, rb_alloc_func_t func,...)
Identical to rb_struct_define(), except it does not define accessor methods.
Definition: struct.c:422
VALUE rb_struct_alloc_noinit(VALUE klass)
Allocates an instance of the given class.
Definition: struct.c:352
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_exec_recursive_paired(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive(), except it checks for the recursion on the ordered pair of { g,...
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
Definition: variable.c:1575
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
Definition: variable.c:1285
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
Definition: vm_method.c:2765
int rb_method_basic_definition_p(VALUE klass, ID mid)
Well... Let us hesitate from describing what a "basic definition" is.
Definition: vm_method.c:2643
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
Definition: vm_eval.c:664
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
Definition: symbol.h:276
ID rb_intern(const char *name)
Finds or creates a symbol of the given name.
Definition: symbol.c:782
VALUE rb_sym2str(VALUE id)
Identical to rb_id2str(), except it takes an instance of rb_cSymbol rather than an ID.
Definition: symbol.c:924
RBIMPL_ATTR_NORETURN() void rb_eof_error(void)
Utility function to raise rb_eEOFError.
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
Definition: iterator.h:58
VALUE rb_block_call(VALUE obj, ID mid, int argc, const VALUE *argv, rb_block_call_func_t proc, VALUE data2)
Identical to rb_funcallv(), except it additionally passes a function as a block.
Definition: vm_eval.c:1595
VALUE rb_yield(VALUE val)
Yields the block.
Definition: vm_eval.c:1357
void rb_marshal_define_compat(VALUE newclass, VALUE oldclass, VALUE(*dumper)(VALUE), VALUE(*loader)(VALUE, VALUE))
Marshal format compatibility layer.
Definition: marshal.c:148
#define RARRAY_AREF(a, i)
Definition: rarray.h:588
#define RBASIC(obj)
Convenient casting macro.
Definition: rbasic.h:40
#define RBIGNUM_SIGN
Just another name of rb_big_sign.
Definition: rbignum.h:29
static bool RBIGNUM_NEGATIVE_P(VALUE b)
Checks if the bignum is negative.
Definition: rbignum.h:74
static bool RBIGNUM_POSITIVE_P(VALUE b)
Checks if the bignum is positive.
Definition: rbignum.h:61
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
Definition: variable.c:309
#define RTEST
This is an old name of RB_TEST.
static bool RB_FLOAT_TYPE_P(VALUE obj)
Queries if the object is an instance of rb_cFloat.
Definition: value_type.h:263
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition: value_type.h:375