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+.



3036
3037
3038
3039
3040
3041
3042
3043
3044
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3036

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.



3047
3048
3049
3050
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3047

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.



3054
3055
3056
3057
3058
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3054

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.



3061
3062
3063
3064
3065
3066
3067
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3061

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+.



3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3088

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)


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

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)


3127
3128
3129
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3127

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+



3132
3133
3134
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3132

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.



3138
3139
3140
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3138

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.



3144
3145
3146
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3144

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).



3165
3166
3167
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3165

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

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

WH implementation of the Ruby count.



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

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.



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

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

#sdrop(n) ⇒ Object

HW implementation of the Ruby drop.



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

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

#sdrop_while(&ruby_block) ⇒ Object

HW implementation of the Ruby drop_while.



3193
3194
3195
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3193

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



3198
3199
3200
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3198

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.



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

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.


3420
3421
3422
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3420

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.


3115
3116
3117
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3115

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



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

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.



3214
3215
3216
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3214

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.



3220
3221
3222
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3220

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.



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

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.



3235
3236
3237
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3235

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.



3240
3241
3242
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3240

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



3159
3160
3161
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3159

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.



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

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.



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

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.



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

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)


3263
3264
3265
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3263

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

#sinject(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby inject.



3268
3269
3270
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3268

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.



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

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.



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

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

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

HW implementation of the Ruby max.



3285
3286
3287
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3285

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.



3290
3291
3292
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3290

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.



3295
3296
3297
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3295

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.



3300
3301
3302
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3300

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.



3305
3306
3307
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3305

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

#sminmax_by(&ruby_block) ⇒ Object

HW implementation of the Ruby minmax_by.



3310
3311
3312
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3310

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)


3316
3317
3318
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3316

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)


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

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.



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

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

#sreduceObject

HW implementation of the Ruby reduce.



3273
3274
3275
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3273

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

#sreject(&ruby_block) ⇒ Object

HW implementatiob of the Ruby reject.



3333
3334
3335
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3333

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.



3338
3339
3340
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3338

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.



3230
3231
3232
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3230

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.



3344
3345
3346
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3344

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.



3350
3351
3352
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3350

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.



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

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

#ssort(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



3366
3367
3368
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3366

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

#ssort_by(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



3371
3372
3373
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3371

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.



3361
3362
3363
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3361

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.



3376
3377
3378
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3376

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.



3381
3382
3383
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3381

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

#stake_while(&ruby_block) ⇒ Object

The HW implementation of the Ruby take_while.



3386
3387
3388
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3386

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.



3392
3393
3394
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3392

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

#sto_aObject

HW implementation of the Ruby to_a.



3225
3226
3227
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3225

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.



3398
3399
3400
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3398

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

#suniq(&ruby_block) ⇒ Object

HW implementation of the Ruby uniq.



3403
3404
3405
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3403

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.



3410
3411
3412
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3410

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

#to_cObject

Convert to C code.



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

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.



3070
3071
3072
3073
3074
3075
3076
3077
3078
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3070

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