Class: RubyHDL::High::Siter

Inherits:
Statement show all
Defined in:
lib/HDLRuby/std/sequencer_sw.rb

Overview

Describes a SW implementation of an iterator statement.

Instance Method Summary collapse

Constructor Details

#initialize(sequencer, *commands, &ruby_block) ⇒ Siter

Create a new iteration statement in sequencer +sequencer+ for chain of commands +commands+ to interate while executing +ruby_block+.



2973
2974
2975
2976
2977
2978
2979
2980
2981
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2973

def initialize(sequencer,*commands, &ruby_block)
  @sequencer = sequencer
  @commands = commands
  if ruby_block then
    # The iterator is finalized.
    @blk = Sblock.new(sequencer,&ruby_block)
  end
  # puts "New iterator with blk=#{@blk} commands=#{@commands}"
end

Instance Method Details

#each_command(&ruby_block) ⇒ Object Also known as: each

Iterate on the commands.



2984
2985
2986
2987
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2984

def each_command(&ruby_block)
  return to_enum(:each_command) unless ruby_block
  @commands.each(&ruby_block)
end

#each_statement(&ruby_block) ⇒ Object

Iterate on the statements.



2991
2992
2993
2994
2995
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2991

def each_statement(&ruby_block)
  return to_enum(:each_statement) unless ruby_block
  # Apply ruby_block on the block.
  @blk.each_statement(&ruby_block)
end

#each_statement_deep(&ruby_block) ⇒ Object

Iterate deeply on the statements.



2998
2999
3000
3001
3002
3003
3004
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2998

def each_statement_deep(&ruby_block)
  return to_enum(:each_statement_deep) unless ruby_block
  # Recurse on the yes block.
  @blk.each_statement_deep
  # And apply ruby_block on self.
  ruby_block.call(self)
end

#make_iterator(meth, *args, &ruby_block) ⇒ Object

Create an iterator for a given method +meth+.



3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3025

def make_iterator(meth,*args,&ruby_block)
  # if ruby_block then
  #   blk = Sblock.new(@sequencer,&ruby_block)
  #   command = RubyHDL::High::Ruby.new do
  #     "#{meth}(#{args.map{|arg| arg.to_ruby}.join(",")}) { #{blk.to_ruby} }"
  #   end
  # else
  #   command = RubyHDL::High::Ruby.new do
  #     "#{meth}(#{args.map{|arg| arg.to_ruby}.join(",")})"
  #   end
  # end
  command = "#{meth}"
  if args.any? then
    command += "(*#{RubyHDL::High::Ruby.new {
    "#{args.map{|arg| arg.to_ruby}.join(",")}"}})"
  end
  return Siter.new(@sequencer,*@commands,command,&ruby_block)
end

#sall?(arg = nil, &ruby_block) ⇒ Boolean

Tell if all the elements respect a given criterion given either as +arg+ or as block.

Returns:

  • (Boolean)


3058
3059
3060
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3058

def sall?(arg = nil,&ruby_block)
  return self.make_iterator("all?",arg,&ruby_block)
end

#sany?(arg = nil, &ruby_block) ⇒ Boolean

Tell if any of the elements respects a given criterion given either as +arg+ or as block.

Returns:

  • (Boolean)


3064
3065
3066
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3064

def sany?(arg = nil,&ruby_block)
  return self.make_iterator("any?",arg,&ruby_block)
end

#schain(arg) ⇒ Object

Returns an SEnumerator generated from current enumerable and +arg+



3069
3070
3071
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3069

def schain(arg)
  return self.make_iterator("chain",arg)
end

#schunk(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby chunk. NOTE: to do, or may be not.



3075
3076
3077
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3075

def schunk(*args,&ruby_block)
  raise "schunk is not supported yet."
end

#schunk_while(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby chunk_while. NOTE: to do, or may be not.



3081
3082
3083
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3081

def schunk_while(*args,&ruby_block)
  raise "schunk_while is not supported yet."
end

#scompactObject

HW implementation of the Ruby compact, but remove 0 values instead on nil (since nil that does not have any meaning in HW).



3102
3103
3104
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3102

def scompact
  return self.make_iterator("compact",&ruby_block)
end

#scount(obj = nil, &ruby_block) ⇒ Object

WH implementation of the Ruby count.



3108
3109
3110
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3108

def scount(obj = nil, &ruby_block)
  return self.make_iterator("count",obj,&ruby_block)
end

#scycle(n = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby cycle.



3113
3114
3115
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3113

def scycle(n = nil,&ruby_block)
  return self.make_iterator("cycle",n,&ruby_block)
end

#sdrop(n) ⇒ Object

HW implementation of the Ruby drop.



3125
3126
3127
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3125

def sdrop(n)
  return self.make_iterator("drop",n)
end

#sdrop_while(&ruby_block) ⇒ Object

HW implementation of the Ruby drop_while.



3130
3131
3132
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3130

def sdrop_while(&ruby_block)
  return self.make_iterator("drop_while",&ruby_block)
end

#seach_cons(n, &ruby_block) ⇒ Object

HW implementation of the Ruby each_cons



3135
3136
3137
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3135

def seach_cons(n,&ruby_block)
  return self.make_iterator("each_cons",n,&ruby_block)
end

#seach_entry(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby each_entry. NOTE: to do, or may be not.



3141
3142
3143
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3141

def seach_entry(*args,&ruby_block)
  raise "seach_entry is not supported yet."
end

#seach_nexts(num, &ruby_block) ⇒ Object

Iterator on the +num+ next elements. NOTE:

  • Stop iteration when the end of the range is reached or when there are no elements left
  • This is not a method from Ruby but one specific for hardware where creating a array is very expensive.


3357
3358
3359
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3357

def seach_nexts(num,&ruby_block)
  return self.seach.snexts(num,&ruby_block)
end

#seach_range(rng, &ruby_block) ⇒ Object

Iterator on each of the elements in range +rng+. NOTE:

  • Stop iteration when the end of the range is reached or when there are no elements left
  • This is not a method from Ruby but one specific for hardware where creating a array is very expensive.


3052
3053
3054
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3052

def seach_range(rng,&ruby_block)
  return self.make_iterator("each_range",rng,&ruby_block)
end

#seach_slice(n, &ruby_block) ⇒ Object

HW implementation of the Ruby each_slice



3146
3147
3148
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3146

def seach_slice(n,&ruby_block)
  return self.make_iterator("each_slice",n,&ruby_block)
end

#seach_with_index(*args, &ruby_block) ⇒ Object Also known as: with_index

HW implementation of the Ruby each_with_index.



3151
3152
3153
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3151

def seach_with_index(*args,&ruby_block)
  return self.make_iterator("each_with_index",*args,&ruby_block)
end

#seach_with_object(obj, &ruby_block) ⇒ Object

HW implementation of the Ruby each_with_object.



3157
3158
3159
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3157

def seach_with_object(obj,&ruby_block)
  return self.make_iterator("each_with_object",obj,&ruby_block)
end

#sfind(if_none_proc, &ruby_block) ⇒ Object

HW implementation of the Ruby find. NOTE: contrary to Ruby, if_none_proc is mandatory since there is no nil in HW. Moreover, the argument can also be a value.



3120
3121
3122
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3120

def sfind(if_none_proc, &ruby_block)
  return self.make_iterator("find",if_none_proc,&ruby_block)
end

#sfind_index(obj = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby find_index.



3172
3173
3174
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3172

def sfind_index(obj = nil, &ruby_block)
  return self.make_iterator("find_index",obj,&ruby_block)
end

#sfirst(n = 1) ⇒ Object

HW implementation of the Ruby first.



3177
3178
3179
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3177

def sfirst(n=1)
  return self.make_iterator("first",n)
end

#sflat_map(&ruby_block) ⇒ Object

HW implementation of the Ruby flat_map. NOTE: actually due to the way HDLRuby handles vectors, should work like smap



3096
3097
3098
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3096

def sflat_map(&ruby_block)
  return self.make_iterator("flat_map",&ruby_block)
end

#sgrep(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby grep. NOTE: to do, or may be not.



3183
3184
3185
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3183

def sgrep(*args,&ruby_block)
  raise "sgrep is not supported yet."
end

#sgrep_v(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby grep_v. NOTE: to do, or may be not.



3189
3190
3191
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3189

def sgrep_v(*args,&ruby_block)
  raise "sgrep_v is not supported yet."
end

#sgroup_by(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby group_by. NOTE: to do, or may be not.



3195
3196
3197
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3195

def sgroup_by(*args,&ruby_block)
  raise "sgroup_by is not supported yet."
end

#sinclude?(obj) ⇒ Boolean

HW implementation of the Ruby include?

Returns:

  • (Boolean)


3200
3201
3202
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3200

def sinclude?(obj)
  return self.make_iterator("include?",obj)
end

#sinject(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby inject.



3205
3206
3207
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3205

def sinject(*args,&ruby_block)
  return self.make_iterator("inject",*args,&ruby_block)
end

#slazy(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby lazy. NOTE: to do, or may be not.



3217
3218
3219
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3217

def slazy(*args,&ruby_block)
  raise "slazy is not supported yet."
end

#smap(&ruby_block) ⇒ Object

Returns a vector containing the execution result of the given block on each element. If no block is given, return an SEnumerator. NOTE: be carful that the resulting vector can become huge if there are many element.



3089
3090
3091
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3089

def smap(&ruby_block)
  return self.make_iterator("map",&ruby_block)
end

#smax(n = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby max.



3222
3223
3224
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3222

def smax(n = nil, &ruby_block)
  return self.make_iterator("max",n,&ruby_block)
end

#smax_by(n = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby max_by.



3227
3228
3229
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3227

def smax_by(n = nil, &ruby_block)
  return self.make_iterator("max_by",n,&ruby_block)
end

#smin(n = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby min.



3232
3233
3234
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3232

def smin(n = nil, &ruby_block)
  return self.make_iterator("min",n,&ruby_block)
end

#smin_by(n = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby min_by.



3237
3238
3239
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3237

def smin_by(n = nil, &ruby_block)
  return self.make_iterator("min_by",n,&ruby_block)
end

#sminmax(&ruby_block) ⇒ Object

HW implementation of the Ruby minmax.



3242
3243
3244
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3242

def sminmax(&ruby_block)
  return self.make_iterator("minmax",&ruby_block)
end

#sminmax_by(&ruby_block) ⇒ Object

HW implementation of the Ruby minmax_by.



3247
3248
3249
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3247

def sminmax_by(&ruby_block)
  return self.make_iterator("minmax_by",&ruby_block)
end

#snone?(arg = nil, &ruby_block) ⇒ Boolean

Tell if none of the elements respects a given criterion given either as +arg+ or as block.

Returns:

  • (Boolean)


3253
3254
3255
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3253

def snone?(arg = nil,&ruby_block)
  return self.make_iterator("none?",arg,&ruby_block)
end

#sone?(arg = nil, &ruby_block) ⇒ Boolean

Tell if one and only one of the elements respects a given criterion given either as +arg+ or as block.

Returns:

  • (Boolean)


3259
3260
3261
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3259

def sone?(arg = nil,&ruby_block)
  return self.make_iterator("one?",arg,&ruby_block)
end

#spartition(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby partition. NOTE: to do, or may be not.



3265
3266
3267
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3265

def spartition(*args,&ruby_block)
  raise "spartition is not supported yet."
end

#sreduceObject

HW implementation of the Ruby reduce.



3210
3211
3212
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3210

def sreduce
  return self.make_iterator("reduce",*args,&ruby_block)
end

#sreject(&ruby_block) ⇒ Object

HW implementatiob of the Ruby reject.



3270
3271
3272
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3270

def sreject(&ruby_block)
  return self.make_iterator("reject",&ruby_block)
end

#sreverse_each(*args, &ruby_block) ⇒ Object

HW implementatiob of the Ruby reverse_each.



3275
3276
3277
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3275

def sreverse_each(*args,&ruby_block)
  return self.make_iterator("reverse_each",*args,&ruby_block)
end

#sselect(&ruby_block) ⇒ Object

HW implementation of the Ruby select.



3167
3168
3169
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3167

def sselect(&ruby_block)
  return self.make_iterator("select",&ruby_block)
end

#sslice_after(pattern = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby slice_after. NOTE: to do, or may be not.



3281
3282
3283
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3281

def sslice_after(pattern = nil,&ruby_block)
  raise "sslice_after is not supported yet."
end

#sslice_before(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby slice_before. NOTE: to do, or may be not.



3287
3288
3289
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3287

def sslice_before(*args,&ruby_block)
  raise "sslice_before is not supported yet."
end

#sslice_when(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby slice_when. NOTE: to do, or may be not.



3293
3294
3295
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3293

def sslice_when(*args,&ruby_block)
  raise "sslice_before is not supported yet."
end

#ssort(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



3303
3304
3305
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3303

def ssort(&ruby_block)
  return self.make_iterator("sort",&ruby_block)
end

#ssort_by(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



3308
3309
3310
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3308

def ssort_by(&ruby_block)
  return self.make_iterator("sort_by",&ruby_block)
end

#ssort_merge(arI, arO, first, middle, last, &ruby_block) ⇒ Object

Merge two arrays in order, for ssort only.



3298
3299
3300
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3298

def ssort_merge(arI, arO, first, middle, last, &ruby_block)
  return self.make_iterator("sort_merge",arI,arO,first,middle,last,&ruby_block)
end

#ssum(initial_value = nil, &ruby_block) ⇒ Object

HW implementation of the Ruby sum.



3313
3314
3315
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3313

def ssum(initial_value = nil,&ruby_block)
  return self.make_iterator("sum",initial_value,&ruby_block)
end

#stake(n) ⇒ Object

The HW implementation of the Ruby take.



3318
3319
3320
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3318

def stake(n)
  return self.make_iterator("take",n)
end

#stake_while(&ruby_block) ⇒ Object

The HW implementation of the Ruby take_while.



3323
3324
3325
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3323

def stake_while(&ruby_block)
  return self.make_iterator("take_while",&ruby_block)
end

#stally(h = nil) ⇒ Object

HW implementation of the Ruby tally. NOTE: to do, or may be not.



3329
3330
3331
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3329

def stally(h = nil)
  raise "stally is not supported yet."
end

#sto_aObject

HW implementation of the Ruby to_a.



3162
3163
3164
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3162

def sto_a
  return self.make_iterator("to_a")
end

#sto_h(h = nil) ⇒ Object

HW implementation of the Ruby to_h. NOTE: to do, or may be not.



3335
3336
3337
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3335

def sto_h(h = nil)
  raise "sto_h is not supported yet."
end

#suniq(&ruby_block) ⇒ Object

HW implementation of the Ruby uniq.



3340
3341
3342
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3340

def suniq(&ruby_block)
  return self.make_iterator("uniq",&ruby_block)
end

#szip(obj, &ruby_block) ⇒ Object

HW implementation of the Ruby zip. NOTE: for now szip is deactivated untile tuples are properly handled by HDLRuby.



3347
3348
3349
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3347

def szip(obj,&ruby_block)
  return self.make_iterator("zip",obj,&ruby_block)
end

#to_cObject

Convert to C code.



3018
3019
3020
3021
3022
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3018

def to_c
  res = @sequencer.clk_up_c + "\n" +
    @commands.map { |command| command.to_c }.join("_")
  return res + "(#{@blk.to_c})"
end

#to_rubyObject

Convert to Ruby code.



3007
3008
3009
3010
3011
3012
3013
3014
3015
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3007

def to_ruby
  # puts "to_ruby with blk=#{@blk} commands=#{@commands}"
  res = @sequencer.clk_up + "\n" + 
    @commands.map { |command| command.to_ruby }.join(".") 
  return res + " do" + 
    (@blk.each_arg.any? ? 
     "|#{@blk.each_arg.map(&:to_ruby).join(",")}|" : "") + 
    "\n#{@blk.to_ruby}\n#{@sequencer.clk_up}\nend"
end