r_bridge 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678aaf66ad022546771461a682f5dee6efa065402c8890197ac3e809cb491cda
-  data.tar.gz: 6e4c24a1f8fc85599707ca0aa7799a8b7ef7bfbb0fcb7e1f1cc720f58f179046
+  metadata.gz: ee29073e5090bf0ac44de5a81374aad07050f0518ea7bd0c3942d4d7ce523487
+  data.tar.gz: b93811a27fb58066cd93660009c0a9555cf7e74380727149e9f8a353ccb8893d
 SHA512:
-  metadata.gz: 2eabdfe3403067cd795090593deeb96ba2a7d70ace07e9e7540d598df234134bf5969143fcdc27695a09bf65692c24e6fb78db3f59a91b3ce8d741f43382b5c1
-  data.tar.gz: eb0e3cd227b22842584c686b9c93af7ca36434d2754132f58544fcc72b69b406630639abf2a021f2c2c160ecd3c6451d4c842517b806299198aaa5bf48a73a13
+  metadata.gz: ce3cbb9fd43d040599d88e3f49512917b9981f268816c5f82ae2e0722d86e33e3934ae5dacf796e0c467bdd6ff08001b33f2c25cb97d594698adbe895a199344
+  data.tar.gz: b850ea4e23d9a5b504c94ca761640a9e3e8f34bb08b79809b6e563d0457ac9b9f31257b1817e3eb4c47cb66ec8862c2acbc928ced2a0c901bb445cad656b613b

data/README.md

@@ -216,11 +216,13 @@ RBridge.create_extptr( ffi_ptr )
 
 * Create R function call
 
-create_function_call creates R's internal S expresion structure for function call.
+create_ns_function_call, create_env_function_call and create_function_call create R's internal S expresion structures for function calls. create_ns_function_call can specify (package) namespace. create_env_function_call can specify environment name.
 
-Arguments are passed to the second argument as Ruby Hash, and each Hash's value needs to point to R's object. You usually pass R vectors, but you can also pass another function call as an argument.
+Arguments are passed as Ruby Hash, and each Hash's value needs to point to R's object. You usually pass R vectors, but you can also pass another function call as an argument.
 
 ```
+RBridge.create_ns_function_call( ns, fname, hash )
+RBridge.create_env_function_call( env, fname, hash )
 RBridge.create_function_call( fname,  hash )
 
 (e.g.)
@@ -231,6 +233,21 @@ RBridge.exec_function_no_return(hellowrold)
 # pass another function call to argument
 getwd = RBridge.create_function_call( "print", { "x" => RBridge.create_function_call( "getwd", {} ) } )
 RBridge.exec_function_no_return(getwd)
+
+# call sqrt function in base package.
+ivec = RBridge.create_intvec([1,2,3])
+calc = RBridge.create_ns_function_call( "base","sqrt", {"x" => ivec} )
+RBridge.exec_function_no_return( RBridge.create_function_call( "print", {"" => calc} )) # execute & print out
+
+# Call function in environment
+#
+# (e.g.) source the following newenv.R and call the newenv$hello function.
+# # newenv.R
+# newenv = new.env()
+# newenv$hello = function(){ print("Hello!") }
+#
+RBridge.exec_function_no_return( RBridge.create_function_call("source", { "" => RBridge.create_strvec(["newenv.R"]) }))
+RBridge.exec_function_no_return( RBridge.create_env_function_call("newenv", "hello", { } ))
 ```
 
 The followings are utility functions. assign() and library() are frequently used in R, and easy ways to create them are provided.
@@ -356,7 +373,7 @@ RBridge.end_embedded_r()
 
 ## Additional Features
 
-* LazyFunc + RParamManager (+ RResultManager): In contrast to create_function_call(), create_lazy_funcion(), which create LazyFunc object, does not need to take existent R objects. It can take RParamName, RResultName and so on, which are not associated with R objects until the function is evaluated.
+* LazyFunc + RParamManager (+ RResultManager): In contrast to create_function_call(), create_lazy_function(), which creates LazyFunc object, does not need to take existent R objects. It can take RParamName, RResultName and so on, which are not associated with R objects until the function is evaluated. create_ns_lazy_function(), create_env_lazy_function() are lazy evaluation version of create_ns_function_call() and create_env_function_call(), which respectively allows specifying namespaces and environments.
 
 These features are being developed for StatSailr, and the API is not stable. They can be accessed but they are not recommended for general usage.
 

data/ext/r_bridge/r_lang.c

@@ -4,6 +4,22 @@
 
 #include "win_compat.h"
 
+EXPORT SEXP
+r_lang_create_ns_fcall( const char* ns, const char* fname, SEXP args)
+{
+    SEXP func;
+    PROTECT( func = LCONS( LCONS( Rf_install("::"), LCONS( Rf_install(ns), LCONS( Rf_install(fname), R_NilValue))) , args ));
+    return func;
+}
+
+EXPORT SEXP
+r_lang_create_env_fcall( const char* env, const char* fname, SEXP args)
+{
+    SEXP func;
+    PROTECT( func = LCONS( LCONS( Rf_install("$"), LCONS( Rf_install(env), LCONS( Rf_install(fname), R_NilValue))) , args ));
+    return func;
+}
+
 EXPORT SEXP
 r_lang_create_fcall( const char* fname, SEXP args)
 {
@@ -12,7 +28,6 @@ r_lang_create_fcall( const char* fname, SEXP args)
     return func;
 }
 
-
 EXPORT SEXP
 r_lang_cons( SEXP car, SEXP cdr)
 {

data/lib/r_bridge/r_bridge_ffi.rb

@@ -24,6 +24,8 @@ module RBridge
   attach_function :r_list_to_dataframe, [:pointer ], :pointer
   attach_function :r_dataframe_set_rownames, [:pointer, :pointer], :void
 
+  attach_function :r_lang_create_ns_fcall, [:string, :string, :pointer], :pointer
+  attach_function :r_lang_create_env_fcall, [:string, :string, :pointer], :pointer
   attach_function :r_lang_create_fcall, [:string, :pointer], :pointer
   attach_function :r_lang_cons, [:pointer, :pointer], :pointer
   attach_function :r_lang_cons_gen, [:pointer], :pointer
@@ -272,6 +274,10 @@ module RBridge
     return new_lcons
   end
 
+  def self.r_nil()
+    return r_lang_nil()
+  end
+
   def self.is_r_nil?( obj )
     result = r_is_nil( obj )
     if(result == 1)
@@ -294,9 +300,8 @@ module RBridge
     return extptr
   end
 
-  def self.create_function_call( fname,  hash )
-    raise "create_function_call should take String for function name" if(fname.class != String) 
-    raise "create_function_call should take Hash for function arguments" if(hash.class != Hash)
+  def self.hash_to_lcons_args( hash ) 
+    raise "hash_to_lcons_args should take Hash argument" if(hash.class != Hash)
     if(hash.size == 0)
       lcons_args = r_lang_nil()
     elsif(hash.size == 1)
@@ -322,6 +327,36 @@ module RBridge
         idx = idx + 1
       }
     end
+    return lcons_args
+  end
+
+  def self.create_ns_function_call( ns, fname, hash )
+    raise "create_ns_function_call should take String for namespace" if(ns.class != String) 
+    raise "create_ns_function_call should take String for function name" if(fname.class != String) 
+    raise "create_ns_function_call should take Hash for function arguments" if(hash.class != Hash)
+    lcons_args = hash_to_lcons_args( hash )
+
+    new_function_call = r_lang_create_ns_fcall(ns, fname, lcons_args)
+    ptr_manager_add_ptr_to_current( new_function_call )
+    return new_function_call
+  end
+
+  def self.create_env_function_call( env, fname, hash )
+    raise "create_env_function_call should take String for env" if(env.class != String) 
+    raise "create_env_function_call should take String for function name" if(fname.class != String) 
+    raise "create_env_function_call should take Hash for function arguments" if(hash.class != Hash)
+    lcons_args = hash_to_lcons_args( hash )
+
+    new_function_call = r_lang_create_env_fcall(env, fname, lcons_args)
+    ptr_manager_add_ptr_to_current( new_function_call )
+    return new_function_call
+  end
+
+  def self.create_function_call( fname,  hash )
+    raise "create_function_call should take String for function name" if(fname.class != String) 
+    raise "create_function_call should take Hash for function arguments" if(hash.class != Hash)
+    lcons_args = hash_to_lcons_args( hash )
+
     new_function_call = r_lang_create_fcall(fname, lcons_args)
     ptr_manager_add_ptr_to_current( new_function_call )
     return new_function_call

data/lib/r_bridge/r_bridge_lazyfunc_ext.rb

@@ -1,21 +1,46 @@
 require "r_bridge/r_bridge_ffi"
 
 module RBridge
+  def self.create_ns_lazy_function( ns, fname, hash , param_manager)
+    raise "create_ns_lazy_function should take String for namespace" if(ns.class != String) 
+    raise "create_ns_lazy_function should take String for function name" if(fname.class != String) 
+    raise "create_ns_lazy_function should take Hash for function arguments" if(hash.class != Hash)
+    return LazyFunc.new( ns, nil, fname, hash , param_manager)
+  end
+
+  def self.create_env_lazy_function( env, fname, hash , param_manager)
+    raise "create_env_lazy_function should take String for environment" if(env.class != String) 
+    raise "create_env_lazy_function should take String for function name" if(fname.class != String) 
+    raise "create_env_lazy_function should take Hash for function arguments" if(hash.class != Hash)
+    return LazyFunc.new( nil, env, fname, hash , param_manager)
+  end
+
   def self.create_lazy_function( fname, hash , param_manager)
     raise "create_lazy_function should take String for function name" if(fname.class != String) 
     raise "create_lazy_function should take Hash for function arguments" if(hash.class != Hash)
-    return LazyFunc.new( fname, hash , param_manager)
+    return LazyFunc.new( nil, nil, fname, hash , param_manager)
   end
 
-  def self.create_function_call_from_lazy_function( fname, fargs, param_manager, result_manager)
+  def self.create_function_call_from_lazy_function_attrs( ns, env, fname, fargs, param_manager, result_manager)
     farg_keys = fargs.keys
 
     new_arg_hash = {}
     farg_keys.each(){|key|
       val = fargs[key]
+
+      if val.is_a? RResultPrevious
+        r_previous = result_manager.get_previous() # if r_nil (i.e. 1st instruction or no previous result-store instructions) we need to use default one.
+        if ! RBridge::is_r_nil?(r_previous)  # When previous result exists
+          new_arg_hash[key] = r_previous
+          break
+        else  # When previous result does not exist
+          val = val.default
+        end
+      end
+
       case val
       when LazyFunc then
-        new_arg_hash[key] = create_function_call_from_lazy_function( val.fname, val.args , param_manager, result_manager )
+        new_arg_hash[key] = create_function_call_from_lazy_function_attrs( val.ns, val.env, val.fname, val.args , param_manager, result_manager )
       when RResultName , RResultNameArray then 
         new_arg_hash[key] = result_manager.get_last_for( val )
       when RParamName then
@@ -27,13 +52,13 @@ module RBridge
           case elem
           when RResultName, RResultNameArray then 
             result = result_manager.get_last_for( elem )
-            if( ! result.nil? )
+            if( ! RBridge::is_r_nil?(result) )
               new_arg_hash[key] = result
               break
             end
           when RParamName then
             result = param_manager.get_r_object( elem )
-            if( ! result.nil? )
+            if( ! RBridge::is_r_nil?(result) )
               new_arg_hash[key] = result
               break
             end
@@ -44,34 +69,52 @@ module RBridge
           idx = idx + 1
         end
         if(idx == val.elems.size ) # Not found
-          new_arg_hash[key] = nil
+          new_arg_hash[key] = RBridge::r_nil()
         end
       else  # R object
         new_arg_hash[key] = val
       end
     }
-    return create_function_call( fname, new_arg_hash )
+    if( ns.nil? )
+      if( env.nil? )
+        return create_function_call( fname, new_arg_hash )
+      else
+        return create_env_function_call( env, fname, new_arg_hash )
+      end
+    else
+      if( env.nil? )
+        return create_ns_function_call( ns, fname, new_arg_hash )
+      else
+        raise "namespace and environment are not allowed to be specified at the same time."
+      end
+    end
   end
 
   def self.exec_lazy_function( lazy_func , result_manager , allow_nil_result: false )
     raise "exec_lazy_function should take LazyFunc object" if(lazy_func.class != LazyFunc) 
     raise "exec_lazy_function should take RResultManager or Nil for 2nd argment: " + result_manager.class.to_s  if(! [RResultManager, NilClass].include?(result_manager.class) )
+    ns = lazy_func.ns
+    env = lazy_func.env
     fname = lazy_func.fname
     arg_hash = lazy_func.args
     param_manager = lazy_func.param_manager
 
-    func = create_function_call_from_lazy_function(fname, arg_hash, param_manager, result_manager)
+    func = create_function_call_from_lazy_function_attrs(ns, env, fname, arg_hash, param_manager, result_manager)
     result = exec_function( func , allow_nil_result: allow_nil_result )
     return result
   end
 
   class LazyFunc
+    attr :ns
+    attr :env
     attr :fname
     attr :args
     attr :param_manager
 
-    def initialize( fname, arg_hash, param_manager)
+    def initialize( ns, env, fname, arg_hash, param_manager)
       raise "LazyFunc requires RParamManager object for param_manager argument " if ! param_manager.is_a?(RParamManager)
+      @ns = ns  # When namespace does not need to be specified, set nil.
+      @env = env  # When environment does not need to be specified, set nil.
       @fname = fname
       @args = arg_hash
       @param_manager = param_manager
@@ -86,6 +129,7 @@ module RBridge
   end
 
   class RParamManager
+    attr :param_hash , true
     def initialize(hash)
       @param_hash = hash
     end
@@ -112,6 +156,18 @@ module RBridge
     end
   end
 
+  class RResultPrevious
+    # RResultPrevious is used for result from the previous instruction.
+    # If the instruction is the 1st one, there are no previous ones. At this time, default one is used.
+    attr :default
+    def initialize(val)
+      if ! ( val.is_a?(RNameContainer) || val.is_a?(RResultName) || val.is_a?(RResultNameArray) || val.is_a?(RParamName) || ::RBridge.is_pointer?( val ) )
+        raise "RResultPrevious.new requires RNameContainer, RResultName, RResultNameArray, RParamName or R object as default"
+      end
+      @default = val
+    end
+  end
+
   class RResultManager
     def initialize
       @results = []
@@ -125,7 +181,7 @@ module RBridge
       @results << [inst_name, r_obj ]
     end
 
-    def get_last_index_for( result_name )
+    def get_last_index_for( result_name ) # From this method, if result name is not found return (Ruby) nil.
         name = result_name.name
 
         idx = @results.size - 1
@@ -143,18 +199,18 @@ module RBridge
         end
     end
 
-    def get_last_for( r_result )  # If corresponding result name is not found, return nil.
+    def get_last_for( r_result )  # If corresponding result name is not found, return r_nil().
       raise "get_last_for method requires RResultName or RResultNameArray for its argument." if ! ( r_result.is_a?(RResultName) || r_result.is_a?(RResultNameArray) )
       if( r_result.is_a? RResultName)
         inst_name = r_result.name
 
         elem_to_match = @results.reverse.find{|elem| elem[0] == inst_name }
         if elem_to_match.nil?
-          return nil
+          return RBridge::r_nil()
         else
           r_obj = elem_to_match[1]
           if RBridge::is_r_nil?( r_obj )
-            return nil
+            return RBridge::r_nil()
           else
             return r_obj
           end
@@ -170,7 +226,7 @@ module RBridge
         }
 
         if( index_array.all?(nil) )
-          return nil
+          return RBridge::r_nil()
         else
           index_array.delete(nil)
           if ! index_array.empty?
@@ -178,13 +234,23 @@ module RBridge
             r_obj = @results[last_idx][1]
             return r_obj
           else
-            return nil
+            return RBridge::r_nil()
           end
         end
       else
         raise "get_last_for() takes unexpected object"
       end
     end
+
+    def get_previous()
+       p @results
+       if @results.size > 0
+        r_obj = @results.last[1]
+        return r_obj
+      else
+        return RBridge::r_nil()
+      end
+    end
   end
 
   class RNameContainer

data/lib/r_bridge/version.rb

@@ -1,3 +1,3 @@
 module RBridge
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_bridge
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Toshihiro Umehara
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2021-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -73,7 +73,7 @@ metadata:
   homepage_uri: https://github.com/niceume/r_bridge
   source_code_uri: https://github.com/niceume/r_bridge
   changelog_uri: https://github.com/niceume/r_bridge
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Enables Ruby to construct and evaluate R internal objects
 test_files: []