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, #count, #cycle, #detect, #drop, #drop_while, #each_cons, #each_entry, #each_slice, #each_with_index, #each_with_object, #entries, #enumerator_size, #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, #uniq, #zip
  Constructor Details
  
    
  
  
    #initialize(first, last, exclude = false)  ⇒ Range 
  
  
  
  
    Returns a new instance of Range
   
 
  
    
      
10
11
12
13
14
15
16
17 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 10
def initialize(first, last, exclude = false)
  raise NameError, "'initialize' called twice" if @begin
  raise ArgumentError, 'bad value for range' unless first <=> last
  @begin = first
  @end   = last
  @excl  = exclude
end 
     | 
  
 
  
 
  
    Instance Attribute Details
    
      
      
      
  
  
    Returns the value of attribute begin
   
 
  
  
    
      
8
9
10 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 8
def begin
  @begin
end 
     | 
  
 
    
      
      
      
  
  
    Returns the value of attribute end
   
 
  
  
    
      
8
9
10 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 8
def end
  @end
end 
     | 
  
 
    
   
  
    Instance Method Details
    
      
  
  
    #==(other)  ⇒ Object 
  
  
  
  
    
      
19
20
21
22
23
24
25
26
27
28
29 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 19
def ==(other)
  %x{
    if (!other.$$is_range) {
      return false;
    }
    return self.excl  === other.excl &&
           self.begin ==  other.begin &&
           self.end   ==  other.end;
  }
end
     | 
  
 
    
      
  
  
    #===(value)  ⇒ Object 
  
  
  
  
    
      
31
32
33 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 31
def ===(value)
  include? value
end 
     | 
  
 
    
      
  
  
    #__marshal__(buffer)  ⇒ Object 
  
  
  
  
    
      
150
151
152
153
154
155
156
157
158
159
160
161
162 
     | 
    
      # File 'opal/opal/corelib/marshal/write_buffer.rb', line 150
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 
  
  
  
  
    
      
238
239
240
241
242
243
244
245
246 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 238
def bsearch(&block)
  return enum_for(:bsearch) unless block_given?
  unless `self.begin.$$is_number && self.end.$$is_number`
    raise TypeError, "can't do binary search for #{@begin.class}"
  end
  to_a.bsearch(&block)
end
     | 
  
 
    
      
  
  
    #cover?(value)  ⇒ Boolean 
  
  
    Also known as:
    include?, member?
    
  
  
  
    
      
35
36
37
38
39
40
41
42
43
44 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 35
def cover?(value)
  beg_cmp = (@begin <=> value)
  return false unless beg_cmp && beg_cmp <= 0
  end_cmp = (value <=> @end)
  if @excl
    end_cmp && end_cmp < 0
  else
    end_cmp && end_cmp <= 0
  end
end
     | 
  
 
    
      
  
  
    #each {|current| ... } ⇒ Object 
  
  
  
  
    
      
46
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
77
78
79
80
81
82
83
84
85
86 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 46
def each(&block)
  return enum_for :each unless block_given?
  %x{
    var i, limit;
    if (#{@begin}.$$is_number && #{@end}.$$is_number) {
      if (#{@begin} % 1 !== 0 || #{@end} % 1 !== 0) {
        #{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)
    raise TypeError, "can't iterate from #{current.class}"
  end
  while (current <=> last) < 0
    yield current
    current = current.succ
  end
  yield current if !@excl && current == last
  self
end
     | 
  
 
    
      
  
  
    #eql?(other)  ⇒ Boolean 
  
  
  
  
    
      
88
89
90
91
92
93
94 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 88
def eql?(other)
  return false unless Range === other
  @excl === other.exclude_end? &&
    @begin.eql?(other.begin) &&
    @end.eql?(other.end)
end
     | 
  
 
    
      
  
  
    #exclude_end?  ⇒ Boolean 
  
  
  
  
    
      
96
97
98 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 96
def exclude_end?
  @excl
end 
     | 
  
 
    
      
  
  
    #first(n = undefined)  ⇒ Object 
  
  
  
  
    
      
100
101
102
103 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 100
def first(n = undefined)
  return @begin if `n == null`
  super
end 
     | 
  
 
    
      
  
  
    
      
262
263
264 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 262
def hash
  [@begin, @end, @excl].hash
end 
     | 
  
 
    
      
  
  
    
      
252
253
254 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 252
def inspect
  "#{@begin.inspect}#{@excl ? '...' : '..'}#{@end.inspect}"
end
     | 
  
 
    
      
  
  
    #last(n = undefined)  ⇒ Object 
  
  
  
  
    
      
107
108
109
110 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 107
def last(n = undefined)
  return @end if `n == null`
  to_a.last(n)
end 
     | 
  
 
    
      
  
  
    #marshal_load(args)  ⇒ Object 
  
  
  
  
    
      
256
257
258
259
260 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 256
def marshal_load(args)
  @begin = args[:begin]
  @end = args[:end]
  @excl = args[:excl]
end 
     | 
  
 
    
      
  
  
    FIXME: currently hardcoded to assume range holds numerics
   
 
  
  
    
      
113
114
115
116
117
118
119
120
121
122
123 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 113
def max
  if block_given?
    super
  elsif @begin > @end
    nil
  elsif @excl && @begin == @end
    nil
  else
    `#{@excl} ? #{@end} - 1 : #{@end}`
  end
end
     | 
  
 
    
      
  
  
    
      
127
128
129
130
131
132
133
134
135
136
137 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 127
def min
  if block_given?
    super
  elsif @begin > @end
    nil
  elsif @excl && @begin == @end
    nil
  else
    @begin
  end
end
     | 
  
 
    
      
  
  
    
      
139
140
141
142
143
144
145
146
147
148
149
150 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 139
def size
  range_begin = @begin
  range_end   = @end
  range_end  -= 1 if @excl
  return nil unless Numeric === range_begin && Numeric === range_end
  return 0 if range_end < range_begin
  infinity = Float::INFINITY
  return infinity if [range_begin.abs, range_end.abs].include?(infinity)
  `Math.abs(range_end - range_begin) + 1`.to_i
end 
     | 
  
 
    
      
  
  
    #step(n = 1)  ⇒ Object 
  
  
  
  
    
      
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
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
229
230
231
232
233
234
235
236 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 152
def step(n = 1)
  %x{
    function coerceStepSize() {
      if (!n.$$is_number) {
        n = #{Opal.coerce_to!(n, Integer, :to_int)}
      }
      if (n < 0) {
        #{raise ArgumentError, "step can't be negative"}
      } else if (n === 0) {
        #{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?
    return enum_for(:step, n) do
      %x{
        coerceStepSize();
        return enumeratorSize();
      }
    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) {
        #{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
     | 
  
 
    
      
  
  
    
      
248
249
250 
     | 
    
      # File 'opal/opal/corelib/range.rb', line 248
def to_s
  "#{@begin}#{@excl ? '...' : '..'}#{@end}"
end
     |