Class: RubyHDL::High::Siter

Inherits:
Object
  • Object
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+.



2787
2788
2789
2790
2791
2792
2793
2794
2795
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2787

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.



2798
2799
2800
2801
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2798

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

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

Create an iterator for a given method +meth+.



2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2820

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) 


2853
2854
2855
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2853

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) 


2859
2860
2861
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2859

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+



2864
2865
2866
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2864

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.



2870
2871
2872
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2870

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.



2876
2877
2878
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2876

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

#scompact ⇒ Object

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



2897
2898
2899
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2897

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

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

WH implementation of the Ruby count.



2903
2904
2905
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2903

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.



2908
2909
2910
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2908

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

#sdrop(n) ⇒ Object

HW implementation of the Ruby drop.



2920
2921
2922
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2920

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

#sdrop_while(&ruby_block) ⇒ Object

HW implementation of the Ruby drop_while.



2925
2926
2927
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2925

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



2930
2931
2932
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2930

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.



2936
2937
2938
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2936

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.


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

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.


2847
2848
2849
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2847

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



2941
2942
2943
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2941

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.



2946
2947
2948
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2946

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.



2952
2953
2954
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2952

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.



2915
2916
2917
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2915

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.



2967
2968
2969
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2967

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.



2972
2973
2974
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2972

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



2891
2892
2893
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2891

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.



2978
2979
2980
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2978

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.



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

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.



2990
2991
2992
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2990

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) 


2995
2996
2997
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2995

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

#sinject(*args, &ruby_block) ⇒ Object

HW implementation of the Ruby inject.



3000
3001
3002
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3000

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.



3012
3013
3014
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3012

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.



2884
2885
2886
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2884

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

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

HW implementation of the Ruby max.



3017
3018
3019
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3017

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.



3022
3023
3024
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3022

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.



3027
3028
3029
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3027

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.



3032
3033
3034
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3032

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.



3037
3038
3039
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3037

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

#sminmax_by(&ruby_block) ⇒ Object

HW implementation of the Ruby minmax_by.



3042
3043
3044
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3042

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) 


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

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) 


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

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.



3060
3061
3062
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3060

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

#sreduce ⇒ Object

HW implementation of the Ruby reduce.



3005
3006
3007
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3005

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

#sreject(&ruby_block) ⇒ Object

HW implementatiob of the Ruby reject.



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

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.



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

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.



2962
2963
2964
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2962

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.



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

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.



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

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.



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

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

#ssort(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



3098
3099
3100
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3098

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

#ssort_by(&ruby_block) ⇒ Object

HW implementation of the Ruby sort.



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

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.



3093
3094
3095
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3093

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.



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

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.



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

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

#stake_while(&ruby_block) ⇒ Object

The HW implementation of the Ruby take_while.



3118
3119
3120
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 3118

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.



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

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

#sto_a ⇒ Object

HW implementation of the Ruby to_a.



2957
2958
2959
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2957

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.



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

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

#suniq(&ruby_block) ⇒ Object

HW implementation of the Ruby uniq.



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

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.



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

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

#to_c ⇒ Object

Convert to C code.



2813
2814
2815
2816
2817
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2813

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

#to_ruby ⇒ Object

Convert to Ruby code.



2805
2806
2807
2808
2809
2810
 
# File 'lib/HDLRuby/std/sequencer_sw.rb', line 2805

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\n#{@blk.to_ruby}\n#{@sequencer.clk_up}\nend"
end