BOAST 1.2.2 → 1.3.0

data/lib/BOAST/Language/CPUID_by_name.rb

@@ -5672,4 +5672,5 @@ X86CPUID_by_name ={"_m_from_int64"=>["MMX"],
  "_mm_mask_permutex2var_epi8"=>["AVX512VBMI", "AVX512VL"],
  "_mm_mask2_permutex2var_epi8"=>["AVX512VBMI", "AVX512VL"],
  "_mm_maskz_permutex2var_epi8"=>["AVX512VBMI", "AVX512VL"]}
+  private_constant :X86CPUID_by_name
 end

data/lib/BOAST/Language/Case.rb

@@ -1,5 +1,6 @@
 module BOAST
 
+  # @!parse module Functors; functorize CaseCondition; end
   class CaseCondition < ControlStructure
     attr_reader :block
     attr_reader :constants
@@ -21,6 +22,8 @@ module BOAST
                :break => 'nil' }
     end
 
+    private :get_c_strings, :get_fortran_strings
+
     alias get_cl_strings get_c_strings
     alias get_cuda_strings get_c_strings
 
@@ -70,6 +73,7 @@ module BOAST
 
   end
 
+  # @!parse module Functors; functorize Case; end
   class Case < ControlStructure
 
     attr_reader :expression
@@ -96,6 +100,8 @@ module BOAST
                :end => '"end select"' }
     end
 
+    private :get_c_strings, :get_fortran_strings
+
     alias get_cl_strings get_c_strings
     alias get_cuda_strings get_c_strings
 

data/lib/BOAST/Language/CodeBlock.rb

@@ -1,5 +1,6 @@
 module BOAST
 
+  # @!parse module Functors; functorize CodeBlock; end
   class CodeBlock < Proc
     include PrivateStateAccessor
     include Inspectable

data/lib/BOAST/Language/Comment.rb

@@ -1,5 +1,6 @@
 module BOAST
 
+  # @!parse module Functors; functorize Comment; end
   class Comment
     extend Functor
     include PrivateStateAccessor
@@ -10,6 +11,19 @@ module BOAST
       @comment = string
     end
 
+    def to_s
+      return to_s_fortran if get_lang == FORTRAN
+      return to_s_c if [C,CL,CUDA].include?(get_lang)
+    end
+
+    def pr
+      s = to_s
+      output.puts s
+      return self
+    end
+
+    private
+
     def to_s_fortran
       s = ""
       @comment.each_line { |l| s += "! #{l}" }
@@ -22,17 +36,6 @@ module BOAST
       return s
     end
 
-    def to_s
-      return to_s_fortran if get_lang == FORTRAN
-      return to_s_c if [C,CL,CUDA].include?(get_lang)
-    end
-
-    def pr
-      s = to_s
-      output.puts s
-      return self
-    end
-
   end
 
 end

data/lib/BOAST/Language/Config.rb

@@ -14,6 +14,8 @@ module BOAST
     :fortran_line_length => 72
   }
 
+  module_function
+
   def assert_boast_config_dir
     home_config_dir = ENV["XDG_CONFIG_HOME"]
     home_config_dir = "#{Dir.home}/.config" if not home_config_dir
@@ -25,8 +27,6 @@ module BOAST
     return boast_config_dir
   end
 
-  module_function :assert_boast_config_dir
-
   def read_boast_config
     boast_config_dir = assert_boast_config_dir
     return unless boast_config_dir
@@ -42,17 +42,21 @@ module BOAST
     end
   end
 
-  module_function :read_boast_config
-
   read_boast_config
 
   module PrivateStateAccessor
 
-    private_state_accessor :output, :lang, :architecture, :model, :address_size
-    private_state_accessor :default_int_size, :default_real_size
+    private_state_accessor :output
+    private_state_accessor :lang
+    private_state_accessor :architecture
+    private_state_accessor :model
+    private_state_accessor :address_size
+    private_state_accessor :default_int_size
+    private_state_accessor :default_real_size
     private_state_accessor :default_align
     private_state_accessor :array_start
-    private_state_accessor :indent_level, :indent_increment
+    private_state_accessor :indent_level
+    private_state_accessor :indent_increment
     private_state_accessor :annotate_list
     private_state_accessor :annotate_indepth_list
     private_state_accessor :annotate_level
@@ -70,11 +74,17 @@ module BOAST
 
   end
 
-  state_accessor :output, :lang, :architecture, :model, :address_size
-  state_accessor :default_int_size, :default_real_size
+  state_accessor :output
+  state_accessor :lang
+  state_accessor :architecture
+  state_accessor :model
+  state_accessor :address_size
+  state_accessor :default_int_size
+  state_accessor :default_real_size
   state_accessor :default_align
   state_accessor :array_start
-  state_accessor :indent_level, :indent_increment
+  state_accessor :indent_level
+  state_accessor :indent_increment
   state_accessor :annotate_list
   state_accessor :annotate_indepth_list
   state_accessor :annotate_level
@@ -114,18 +124,18 @@ module BOAST
   default_state_getter :disable_openmp,        false
   default_state_getter :boast_inspect, false, nil, :INSPECT
 
-  alias use_vla_old? use_vla?
   class << self
     alias use_vla_old? use_vla?
+    private :use_vla_old?
   end
 
+  # @return the boolean evaluation of the *use_vla* state. false if lang is CL or CUDA.
   def use_vla?
     return false if [CL,CUDA].include?(lang)
     return use_vla_old?
   end
 
-  module_function :use_vla?
-
+  # @private
   def get_default_architecture
     architecture = const_get(ENV["ARCHITECTURE"]) if ENV["ARCHITECTURE"]
     architecture = const_get(ENV["ARCH"]) if not architecture and ENV["ARCH"]
@@ -134,8 +144,6 @@ module BOAST
     return X86
   end
 
-  module_function :get_default_architecture
-
   @@architecture = get_default_architecture
 
 end

data/lib/BOAST/Language/ControlStructure.rb

@@ -17,12 +17,20 @@ module BOAST
                FORTRAN => get_fortran_strings }
     end
 
-    def self.token_string_generator(name, *args)
+    private :get_strings
+
+    class << self
+
+      def token_string_generator(name, *args)
        s = <<EOF
     def #{name}_string(#{args.join(",")})
-      return eval get_strings[get_lang][:#{name}] 
+      return eval get_strings[get_lang][:#{name}]
     end
 EOF
+      end
+
+      private :token_string_generator
+
     end
 
     def [](*args)

data/lib/BOAST/Language/DataTypes.rb

@@ -1,5 +1,6 @@
 module BOAST
 
+  # Base class for BOAST data types. Inherited class will define a functor.
   class DataType
     include Intrinsics
     include PrivateStateAccessor
@@ -10,6 +11,7 @@ module BOAST
 
   end
 
+  # @!parse module VarFunctors; var_functorize Sizet; end
   class Sizet < DataType
 
     attr_reader :signed
@@ -60,6 +62,7 @@ module BOAST
 
   end
  
+  # @!parse module VarFunctors; var_functorize Real; end
   class Real < DataType
 
     attr_reader :size
@@ -135,6 +138,7 @@ module BOAST
 
   end
 
+  # @!parse module VarFunctors; var_functorize Int; end
   class Int < DataType
 
     attr_reader :size
@@ -246,6 +250,7 @@ module BOAST
 
   end
 
+  # @!parse module VarFunctors; var_functorize CStruct; end
   class CStruct < DataType
 
     attr_reader :name, :members, :members_array
@@ -261,31 +266,26 @@ module BOAST
       }
     end
 
-    def decl_c
-      return "struct #{@name}" if [C, CL, CUDA].include?( lang )
-    end
-
-    def decl_fortran
-      return "TYPE(#{@name})" if lang == FORTRAN
-    end
-
     def decl
       return decl_c if [C, CL, CUDA].include?( lang )
       return decl_fortran if lang == FORTRAN
     end
 
-    def finalize
-       s = ""
-       s += ";" if [C, CL, CUDA].include?( lang )
-       s+="\n"
-       return s
-    end
-
     def define
       return define_c if [C, CL, CUDA].include?( lang )
       return define_fortran if lang == FORTRAN
     end
 
+    private
+
+    def decl_c
+      return "struct #{@name}" if [C, CL, CUDA].include?( lang )
+    end
+
+    def decl_fortran
+      return "TYPE(#{@name})" if lang == FORTRAN
+    end
+
     def define_c
       s = indent
       s += decl_c + " {"
@@ -318,8 +318,16 @@ module BOAST
       return self
     end
 
+    def finalize
+       s = ""
+       s += ";" if [C, CL, CUDA].include?( lang )
+       s+="\n"
+       return s
+    end
+
   end
 
+  # @!parse module VarFunctors; var_functorize CustomType; end
   class CustomType < DataType
 
     attr_reader :size, :name, :vector_length

data/lib/BOAST/Language/Expression.rb

@@ -2,6 +2,7 @@ module BOAST
 
   module_function
 
+  # @!parse module Functors; functorize Expression; end
   class Expression
     include PrivateStateAccessor
     include Arithmetic
@@ -39,6 +40,8 @@ module BOAST
       end
       return s
     end
+
+    private :to_s_base
       
     def to_var
       op1 = nil

data/lib/BOAST/Language/For.rb

@@ -1,12 +1,13 @@
 module BOAST
 
+  # @!parse module Functors; functorize For; end
   class For < ControlStructure
     include Annotation
-    ANNOTATIONS = [ :iterator, :begin, :end, :step, :operator ]
+    ANNOTATIONS = [ :iterator, :first, :last, :step, :operator ]
 
     attr_reader :iterator
-    attr_reader :begin
-    attr_reader :end
+    attr_reader :first
+    attr_reader :last
     attr_reader :step
     attr_accessor :block
 
@@ -18,13 +19,13 @@ module BOAST
       @unroll = val
     end
 
-    def initialize(i, b, e, options={}, &block)
+    def initialize(iterator, first, last, options={}, &block)
       default_options = {:step => 1}
       default_options.update( options )
       @options = options
-      @iterator = i
-      @begin = b
-      @end = e
+      @iterator = iterator
+      @first = first
+      @last = last
       @step = default_options[:step]
       @operator = "<="
       @block = block
@@ -65,6 +66,8 @@ module BOAST
                :end => '"end do"' }
     end
 
+    private :get_c_strings, :get_fortran_strings
+
     alias get_cl_strings get_c_strings
     alias get_cuda_strings get_c_strings
 
@@ -72,19 +75,14 @@ module BOAST
     eval token_string_generator( * %w{end})
 
     def to_s
-      s = for_string(@iterator, @begin, @end, @step, @operator)
+      s = for_string(@iterator, @first, @last, @step, @operator)
       return s
     end
 
-#    def u(s = 2)
-#      return [For::new(@iterator, @begin, @end - (@step*s - 1), @options.dup.update( { :step => (@step*s) } ), &@block),
-#              For::new(@iterator, @begin.to_var + ((@end - @begin + 1)/(@step*s))*(@step*s), @end, @options, &@block) ]
-#    end
-#
     def unroll
       opts = @options.clone
       opts[:unroll] = true
-      return For::new(@iterator, @begin, @end, opts, &block)
+      return For::new(@iterator, @first, @last, opts, &block)
     end
 
     def pr_unroll(*args)
@@ -92,19 +90,19 @@ module BOAST
       begin
         begin
           push_env( :replace_constants => true )
-          if @begin.kind_of?(Variable) then
-            start = @begin.constant
-          elsif @begin.kind_of?(Expression) then
-            start = eval "#{@begin}"
+          if @first.kind_of?(Variable) then
+            first = @first.constant
+          elsif @first.kind_of?(Expression) then
+            first = eval "#{@first}"
           else
-            start = @begin.to_i
+            first = @first.to_i
           end
-          if @end.kind_of?(Variable) then
-            e = @end.constant
-          elsif @end.kind_of?(Expression) then
-            e = eval "#{@end}"
+          if @last.kind_of?(Variable) then
+            last = @last.constant
+          elsif @last.kind_of?(Expression) then
+            last = eval "#{@last}"
           else
-            e = @end.to_i
+            last = @last.to_i
           end
           if @step.kind_of?(Variable) then
             step = @step.constant
@@ -113,7 +111,7 @@ module BOAST
           else
             step = @step.to_i
           end
-          raise "Invalid bounds (not constants)!" if not ( start and e and step )
+          raise "Invalid bounds (not constants)!" if not ( first and last and step )
         ensure
           pop_env( :replace_constants )
         end
@@ -125,7 +123,7 @@ module BOAST
         end
         return self
       end
-      range = start..e
+      range = first..last
       @iterator.force_replace_constant = true
       range.step(step) { |i|
         @iterator.constant = i
@@ -135,6 +133,8 @@ module BOAST
       @iterator.constant = nil
     end
 
+    private :pr_unroll
+
     def open
       @openmp.open if @openmp
       s=""
@@ -166,6 +166,11 @@ module BOAST
       return self
     end
 
+#    def u(s = 2)
+#      return [For::new(@iterator, @first, @last - (@step*s - 1), @options.dup.update( { :step => (@step*s) } ), &@block),
+#              For::new(@iterator, @first.to_var + ((@last - @first + 1)/(@step*s))*(@step*s), @last, @options, &@block) ]
+#    end
+
   end
 
 end