Class: Range

Inherits:
Object show all
Includes:
Enumerable
Defined in:
opal/opal/corelib/range.rb,
opal/opal/corelib/marshal/write_buffer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#all?, #any?, #chunk, #chunk_while, #collect, #collect_concat, #compact, #cycle, #detect, #drop, #drop_while, #each_cons, #each_entry, #each_slice, #each_with_index, #each_with_object, #entries, #enumerator_size, #filter_map, #find_all, #find_index, #grep, #grep_v, #group_by, #inject, #lazy, #max_by, #min_by, #minmax, #minmax_by, #none?, #one?, #partition, #reject, #reverse_each, #slice_after, #slice_before, #slice_when, #sort, #sort_by, #sum, #take, #take_while, #tally, #to_h, #to_set, #uniq, #zip

Constructor Details

#initialize(first, last, exclude = false) ⇒ Range

Returns a new instance of Range.



12
13
14
15
16
17
18
19
 
# File 'opal/opal/corelib/range.rb', line 12

def initialize(first, last, exclude = false)
  ::Kernel.raise ::NameError, "'initialize' called twice" if @begin
  ::Kernel.raise ::ArgumentError, 'bad value for range' unless first <=> last || first.nil? || last.nil?

  @begin = first
  @end   = last
  @excl  = exclude
end

Instance Attribute Details

#begin ⇒ Object (readonly)

Returns the value of attribute begin.



10
11
12
 
# File 'opal/opal/corelib/range.rb', line 10

def begin
  @begin
end

#end ⇒ Object (readonly)

Returns the value of attribute end.



10
11
12
 
# File 'opal/opal/corelib/range.rb', line 10

def end
  @end
end

Instance Method Details

#%(n) ⇒ Object 



326
327
328
329
330
331
332
 
# File 'opal/opal/corelib/range.rb', line 326

def %(n)
  if @begin.is_a?(Numeric) && @end.is_a?(Numeric)
    ::Enumerator::ArithmeticSequence.new(self, n, :%)
  else
    step(n)
  end
end

#===(value) ⇒ Object 



21
22
23
24
 
# File 'opal/opal/corelib/range.rb', line 21

def ===(value)
  return false if `value.$$is_range`
  cover? value
end

#__marshal__(buffer) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'opal/opal/corelib/marshal/write_buffer.rb', line 152

def __marshal__(buffer)
  buffer.save_link(self)
  buffer.write_extends(self)
  buffer.append('o')
  buffer.append_symbol(self.class.name)
  buffer.write_fixnum(3)
  buffer.append_symbol('excl')
  buffer.write(exclude_end?)
  buffer.append_symbol('begin')
  buffer.write(self.begin)
  buffer.append_symbol('end')
  buffer.write(self.end)
end

#bsearch(&block) ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'opal/opal/corelib/range.rb', line 334

def bsearch(&block)
  return enum_for(:bsearch) unless block_given?

  if `is_infinite(self) && (self.begin.$$is_number || self.end.$$is_number)`
    ::Kernel.raise ::NotImplementedError, "Can't #bsearch an infinite range"
  end

  unless `self.begin.$$is_number && self.end.$$is_number`
    ::Kernel.raise ::TypeError, "can't do binary search for #{@begin.class}"
  end

  to_a.bsearch(&block)
end

#count(&block) ⇒ Object 



35
36
37
38
39
40
 
# File 'opal/opal/corelib/range.rb', line 35

def count(&block)
  if !block_given? && `is_infinite(self)`
    return ::Float::INFINITY
  end
  super
end

#cover?(value) ⇒ Boolean

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'opal/opal/corelib/range.rb', line 47

def cover?(value)
  compare = ->(a, b) {
    a <=> b || 1
  }

  if `value.$$is_range`
    val_begin = value.begin
    val_end = value.end
    val_excl = value.exclude_end?
    if (@begin && val_begin.nil?) ||
       (@end && val_end.nil?) ||
       (val_begin && val_end && compare.call(val_begin, val_end).then { |c| val_excl ? c >= 0 : c > 0 }) ||
       (val_begin && !cover?(val_begin))
      return false
    end

    cmp = compare.call(@end, val_end)
    return cmp >= 0 if @excl == val_excl
    return cmp > 0 if @excl
    return true if cmp >= 0

    val_max = value.max
    return !val_max.nil? && compare.call(val_max, @end) <= 0
  end

  return false if @begin && compare.call(@begin, value) > 0
  return true if @end.nil?
  end_cmp = compare.call(value, @end)
  @excl ? end_cmp < 0 : end_cmp <= 0
end

#each {|current| ... } ⇒ Object

Yields:

  • (current) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'opal/opal/corelib/range.rb', line 78

def each(&block)
  return enum_for(:each) { size } unless block_given?

  %x{
    var i, limit;

    if (#{@begin}.$$is_number && #{@end}.$$is_number) {
      if (#{@begin} % 1 !== 0 || #{@end} % 1 !== 0) {
        #{::Kernel.raise ::TypeError, "can't iterate from Float"}
      }

      for (i = #{@begin}, limit = #{@end} + #{@excl ? 0 : 1}; i < limit; i++) {
        block(i);
      }

      return self;
    }

    if (#{@begin}.$$is_string && #{@end}.$$is_string) {
      #{@begin.upto(@end, @excl, &block)}
      return self;
    }
  }

  current = @begin
  last    = @end

  unless current.respond_to?(:succ)
    ::Kernel.raise ::TypeError, "can't iterate from #{current.class}"
  end

  while @end.nil? || (current <=> last) < 0
    yield current

    current = current.succ
  end

  yield current if !@excl && current == last

  self
end

#eql?(other) ⇒ Boolean Also known as: ==

Returns:



120
121
122
123
124
125
126
 
# File 'opal/opal/corelib/range.rb', line 120

def eql?(other)
  return false unless ::Range === other

  @excl === other.exclude_end? &&
    @begin.eql?(other.begin) &&
    @end.eql?(other.end)
end

#exclude_end? ⇒ Boolean

Returns:



128
129
130
 
# File 'opal/opal/corelib/range.rb', line 128

def exclude_end?
  @excl
end

#first(n = undefined) ⇒ Object 



132
133
134
135
136
 
# File 'opal/opal/corelib/range.rb', line 132

def first(n = undefined)
  ::Kernel.raise ::RangeError, 'cannot get the minimum of beginless range' if @begin.nil?
  return @begin if `n == null`
  super
end

#hash ⇒ Object 



362
363
364
 
# File 'opal/opal/corelib/range.rb', line 362

def hash
  [::Range, @begin, @end, @excl].hash
end

#include?(val) ⇒ Boolean Also known as: member?

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'opal/opal/corelib/range.rb', line 138

def include?(val)
  if `self.begin.$$is_number || self.end.$$is_number` ||
     @begin.is_a?(::Time) || @end.is_a?(::Time) ||
     ::Integer.try_convert(@begin) || ::Integer.try_convert(@end)
    return cover?(val)
  end

  if `self.begin.$$is_string || self.end.$$is_string`
    if `self.begin.$$is_string && self.end.$$is_string`
      return @begin.upto(@end, @excl).any? { |s| s == val }
    elsif @begin.nil?
      cmp = val <=> @end
      return !cmp.nil? && (@excl ? cmp < 0 : cmp <= 0)
    elsif @end.nil?
      cmp = @begin <=> val
      return !cmp.nil? && cmp <= 0
    end
  end

  # invoke Enumerable#include?
  super
end

#inspect ⇒ Object 



352
353
354
 
# File 'opal/opal/corelib/range.rb', line 352

def inspect
  "#{@begin && @begin.inspect}#{@excl ? '...' : '..'}#{@end && @end.inspect}"
end

#last(n = undefined) ⇒ Object 



161
162
163
164
165
 
# File 'opal/opal/corelib/range.rb', line 161

def last(n = undefined)
  ::Kernel.raise ::RangeError, 'cannot get the maximum of endless range' if @end.nil?
  return @end if `n == null`
  to_a.last(n)
end

#marshal_load(args) ⇒ Object 



356
357
358
359
360
 
# File 'opal/opal/corelib/range.rb', line 356

def marshal_load(args)
  @begin = args[:begin]
  @end = args[:end]
  @excl = args[:excl]
end

#max ⇒ Object

FIXME: currently hardcoded to assume range holds numerics



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'opal/opal/corelib/range.rb', line 168

def max
  if @end.nil?
    ::Kernel.raise ::RangeError, 'cannot get the maximum of endless range'
  elsif block_given?
    super
  elsif !@begin.nil? && (@begin > @end ||
                         @excl && @begin == @end)
    nil
  else
    `#{@excl} ? #{@end} - 1 : #{@end}`
  end
end

#min ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'opal/opal/corelib/range.rb', line 181

def min
  if @begin.nil?
    ::Kernel.raise ::RangeError, 'cannot get the minimum of beginless range'
  elsif block_given?
    super
  elsif !@end.nil? && (@begin > @end ||
                       @excl && @begin == @end)
    nil
  else
    @begin
  end
end

#size ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'opal/opal/corelib/range.rb', line 194

def size
  %x{
    var b = this.begin, e = this.end;

    // If begin is Numeric
    if (#{::Numeric === `b`}) {
      // If end is Numeric
      if (#{::Numeric === `e`}) {
        // Calculating size based on whether range is exclusive or inclusive
        var size = #{`e` - `b`};
        if (size < 0) {
          return 0;
        }
        if (!this.excl) {
          size += 1;
        }
        return (#{::Float === `b`} || #{::Float === `e`}) ? Math.floor(size) : size;
      }
      // If end is nil
      else if (e === nil) {
        return Infinity;
      }
    }
    // If begin is nil
    else if (b === nil) {
      // If end is Numeric
      if (#{::Numeric === `e`}) {
        return Infinity;
      }
    }

    // If neither begin nor end is Numeric
    return nil;
  }
end

#step(n = undefined) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'opal/opal/corelib/range.rb', line 230

def step(n = undefined)
  %x{
    function coerceStepSize() {
      if (n == null) {
        n = 1;
      }
      else if (!n.$$is_number) {
        n = #{::Opal.coerce_to!(n, ::Integer, :to_int)}
      }

      if (n < 0) {
        #{::Kernel.raise ::ArgumentError, "step can't be negative"}
      } else if (n === 0) {
        #{::Kernel.raise ::ArgumentError, "step can't be 0"}
      }
    }

    function enumeratorSize() {
      if (!#{@begin.respond_to?(:succ)}) {
        return nil;
      }

      if (#{@begin}.$$is_string && #{@end}.$$is_string) {
        return nil;
      }

      if (n % 1 === 0) {
        return #{(size / n).ceil};
      } else {
        // n is a float
        var begin = self.begin, end = self.end,
            abs = Math.abs, floor = Math.floor,
            err = (abs(begin) + abs(end) + abs(end - begin)) / abs(n) * #{::Float::EPSILON},
            size;

        if (err > 0.5) {
          err = 0.5;
        }

        if (self.excl) {
          size = floor((end - begin) / n - err);
          if (size * n + begin < end) {
            size++;
          }
        } else {
          size = floor((end - begin) / n + err) + 1
        }

        return size;
      }
    }
  }

  unless block_given?
    if (@begin.is_a?(Numeric) || @begin.nil?) &&
       (@end.is_a?(Numeric) || @end.nil?) &&
       !(@begin.nil? && @end.nil?)

      return ::Enumerator::ArithmeticSequence.new(self, n, :step)
    else
      return enum_for(:step, n) do
        %x{
          coerceStepSize();
          return enumeratorSize();
        }
      end
    end
  end

  `coerceStepSize()`

  if `self.begin.$$is_number && self.end.$$is_number`
    i = 0
    loop do
      current = @begin + i * n
      if @excl
        break if current >= @end
      elsif current > @end
        break
      end
      yield(current)
      i += 1
    end
  else
    %x{
      if (#{@begin}.$$is_string && #{@end}.$$is_string && n % 1 !== 0) {
        #{::Kernel.raise ::TypeError, 'no implicit conversion to float from string'}
      }
    }
    each_with_index do |value, idx|
      yield(value) if idx % n == 0
    end
  end
  self
end

#to_a ⇒ Object 



42
43
44
45
 
# File 'opal/opal/corelib/range.rb', line 42

def to_a
  ::Kernel.raise ::TypeError, 'cannot convert endless range to an array' if `is_infinite(self)`
  super
end

#to_s ⇒ Object 



348
349
350
 
# File 'opal/opal/corelib/range.rb', line 348

def to_s
  "#{@begin || ''}#{@excl ? '...' : '..'}#{@end || ''}"
end