BOAST 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca2740cb851da646fa30581de14043280bd95ffe
-  data.tar.gz: edafed822810e02453fc6418cea1da470ad47c8c
+  metadata.gz: ea64b71758e5e5a415024b05dffe731bf990a1ff
+  data.tar.gz: 6ecb5d7acdae700d5e9521491e3dd71ef751e550
 SHA512:
-  metadata.gz: 8ae1bcaf2964999e45ba8ca1aab3642425f8c24dba9aff508106cf65d5b4baadd0709b3ef12349388dc6e8ea89ca6281de32df3a15bb29ebc87a1780291114da
-  data.tar.gz: b0b4d95e68c5395a9d9740f7f59c900babfa419b261cd000add8d5238899c3178d2953ea073d4721ba397e6cb6678e17e040e1e8e90c82bef02fb7716c941ab9
+  metadata.gz: c827fa7966599f2f807f1f123c2b5a0781260092701d63767da7b75638142ab062b5469f1d14c4d760e1c11f3f693f66fadb085d6a494d5f64188de050433888
+  data.tar.gz: bbef18791ef66fd3b25ad9aaf7b75892e169204b5bb4fbe1da82eb43286b968c7da2e6cec46914aff6a072e27e203f05fe998084657e9d6dd87d86ac3cefe09e

data/BOAST.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'BOAST'
-  s.version = "1.3.0"
+  s.version = "1.3.1"
   s.author = "Brice Videau"
   s.email = "brice.videau@imag.fr"
   s.homepage = "https://github.com/Nanosim-LIG/boast"

data/README.md

@@ -4,6 +4,10 @@ BOAST
 This section will present some simple examples to familiarize the user
 with BOAST. More samples can be found in the git repository.
 
+Documentation can be found here:
+http://www.rubydoc.info/github/Nanosim-LIG/boast/master
+.
+
 Installation
 ------------
 

data/lib/BOAST/Language/DataTypes.rb

@@ -77,6 +77,10 @@ module BOAST
       return false
     end
 
+    # Creates a new instance of Real.
+    # @param [Hash] hash contains named properties for the type
+    # @option hash [Integer] :size size of the Real type in byte. By default {BOAST.get_default_real_size}.
+    # @option hash [Integer] :vector_length length of the vector of Real. By default 1.
     def initialize(hash={})
       if hash[:size] then
         @size = hash[:size]
@@ -151,6 +155,11 @@ module BOAST
       return false
     end
 
+    # Creates a new instance of Int.
+    # @param [Hash] hash contains named properties for the type
+    # @option hash [Integer] :size size of the Int type in byte. By default {BOAST.get_default_int_size}.
+    # @option hash [Integer] :vector_length length of the vector of Int. By default 1.
+    # @option hash [Integer] :signed specifies if the Int is signed or not. By default {BOAST.get_default_int_signed}.
     def initialize(hash={})
       if hash[:size] then
         @size = hash[:size]
@@ -255,6 +264,10 @@ module BOAST
 
     attr_reader :name, :members, :members_array
 
+    # Creates a new structured type.
+    # @param [Hash] hash named options
+    # @option hash [#to_s] :type_name
+    # @option hash [Array<Variable>] :members list of Variable that create the type
     def initialize(hash={})
       @name = hash[:type_name]
       @members = {}

data/lib/BOAST/Language/Procedure.rb

@@ -14,6 +14,12 @@ module BOAST
     attr_reader :properties
     attr_reader :headers
 
+    # Creates a new Procedure
+    # @param [#to_s] name Procedure identifier
+    # @param [Array<Variable>] parameters list of the procedure parameters.
+    # @param [Hash] properties set of named properties for the Procedure.
+    # @option properties [Array<Variables>] :constants list of constant variables that are used in the Procedure. (see parameter in Fortran).
+    # @option properties [Array<#to_s>] :headers list of headers that need to be included in order to compile the Procedure
     def initialize(name, parameters=[], properties={}, &block)
       @name = name
       @parameters = parameters
@@ -46,6 +52,7 @@ module BOAST
       return close_c if [C, CL, CUDA].include?( lang )
     end
 
+    # Returns a {CKernel} with the Procedure as entry point.
     def ckernel
       old_output = output
       k = CKernel::new
@@ -183,6 +190,9 @@ module BOAST
       s = indent + to_s_fortran
       s += "\n"
       increment_indent_level
+      parameters.each { |p|
+        p.type.define if p.type.kind_of? CStruct
+      }
       s += indent + "integer, parameter :: wp=kind(1.0d0)"
       output.puts s
       constants.each { |c|

data/lib/BOAST/Language/Variable.rb

@@ -38,14 +38,14 @@ module BOAST
       @val2 = v2
     end
 
-    # Returns a {String} representation of the {Dimension}
+    # Returns a String representation of the {Dimension}
     def to_s
       if lang == FORTRAN and @val2 then
         return "#{@val1}:#{@val2}"
-      elsif lang == FORTRAN and get_array_start != 1 then
-        return "#{get_array_start}:#{@size-(1+get_array_start)}"
       elsif lang == FORTRAN and size.nil?
         return "*"
+      elsif lang == FORTRAN and get_array_start != 1 then
+        return "#{get_array_start}:#{@size-(1+get_array_start)}"
       else
         return @size.to_s
       end 
@@ -234,7 +234,18 @@ module BOAST
     # Creates a new {Variable}
     # @param [#to_s] name
     # @param [DataType] type
-    # @param [Hash] properties a set of named properties.
+    # @param [Hash] properties a set of named properties. Properties are also propagated to the {DataType}.
+    # @option properties [Symbol] :direction (or *:dir*) can be one of *:in*, *:out* or *:inout*. Specify the intent of the variable.
+    # @option properties [Array<Dimension>] :dimension (or *:dim*) variable is an array rather than a scalar. Dimensions are given in Fortran order (contiguous first).
+    # @option properties [Object] :constant (or *:const*) states that the variable is a constant and give its value. For Variable with the *:dimension* property set must be a {ConstArray}
+    # @option properties [Boolean] :restrict specifies that the compiler can assume no aliasing to this array.
+    # @option properties [Symbol] :allocate specify that the variable is to be allocated and where. Can only be *:heap* or *:stack* for now.
+    # @option properties [Boolean] :local indicates that the variable is to be allocated on the __local space of OpenCL devices or __shared__ space of CUDA devices. In C or FORTRAN this has the same effect as *:allocate* => *:stack*.
+    # @option properties [Boolean] :texture for OpenCL and CUDA. In OpenCL also specifies that a sampler has to be generated to access the array variable.
+    # @option properties [Integer] :align specifies the alignment the variable will be declared/allocated with if allocated or is supposed to have if it is coming from another context.
+    # @option properties [Boolean] :replace_constant specifies that for scalar constants this variable should be replaced by its constant value. For constant arrays, the value of the array will be replaced if the index can be determined at evaluation.
+    # @option properties [Boolean] :deferred_shape for Fortran interface generation mainly see Fortran documentation
+    # @option properties [Boolean] :optional for Fortran interface generation mainly see Fortran documentation
     def initialize(name, type, properties={})
       @name = name.to_s
       @direction = properties[:direction] ? properties[:direction] : properties[:dir]

data/lib/BOAST/Optimization/Optimization.rb

@@ -189,6 +189,7 @@ EOF
 
   end
 
+  # @private
   class GenericOptimization
 
     attr_accessor :repeat

data/lib/BOAST/Runtime/CUDARuntime.rb

@@ -28,7 +28,7 @@ module BOAST
       fill_library_source_old
       get_output.write <<EOF
 extern "C" {
-  #{@procedure.boast_header_s(CUDA)}{
+  #{@procedure.send(:boast_header_s,CUDA)}{
     dim3 dimBlock(block_size[0], block_size[1], block_size[2]);
     dim3 dimGrid(block_number[0], block_number[1], block_number[2]);
     cudaEvent_t __start, __stop;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: BOAST
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Brice Videau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-21 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: narray
@@ -268,4 +268,3 @@ signing_key:
 specification_version: 4
 summary: BOAST is a computing kernel metaprogramming tool.
 test_files: []
-has_rdoc: false