gsl4r 0.0.1 → 0.0.2

data/lib/gsl4r/const_mksa.rb

@@ -0,0 +1,112 @@
+# Generated by gsl4r/bin/generate_consts.rb
+# from /opt/local/include/gsl/gsl_const_mksa.h
+module GSL4r
+  module PhysicalConstants
+    module MKSA
+      SPEED_OF_LIGHT = (2.99792458e8) #  m / s 
+      GRAVITATIONAL_CONSTANT = (6.673e-11) #  m^3 / kg s^2 
+      PLANCKS_CONSTANT_H = (6.62606896e-34) #  kg m^2 / s 
+      PLANCKS_CONSTANT_HBAR = (1.05457162825e-34) #  kg m^2 / s 
+      ASTRONOMICAL_UNIT = (1.49597870691e11) #  m 
+      LIGHT_YEAR = (9.46053620707e15) #  m 
+      PARSEC = (3.08567758135e16) #  m 
+      GRAV_ACCEL = (9.80665e0) #  m / s^2 
+      ELECTRON_VOLT = (1.602176487e-19) #  kg m^2 / s^2 
+      MASS_ELECTRON = (9.10938188e-31) #  kg 
+      MASS_MUON = (1.88353109e-28) #  kg 
+      MASS_PROTON = (1.67262158e-27) #  kg 
+      MASS_NEUTRON = (1.67492716e-27) #  kg 
+      RYDBERG = (2.17987196968e-18) #  kg m^2 / s^2 
+      BOLTZMANN = (1.3806504e-23) #  kg m^2 / K s^2 
+      MOLAR_GAS = (8.314472e0) #  kg m^2 / K mol s^2 
+      STANDARD_GAS_VOLUME = (2.2710981e-2) #  m^3 / mol 
+      MINUTE = (6e1) #  s 
+      HOUR = (3.6e3) #  s 
+      DAY = (8.64e4) #  s 
+      WEEK = (6.048e5) #  s 
+      INCH = (2.54e-2) #  m 
+      FOOT = (3.048e-1) #  m 
+      YARD = (9.144e-1) #  m 
+      MILE = (1.609344e3) #  m 
+      NAUTICAL_MILE = (1.852e3) #  m 
+      FATHOM = (1.8288e0) #  m 
+      MIL = (2.54e-5) #  m 
+      POINT = (3.52777777778e-4) #  m 
+      TEXPOINT = (3.51459803515e-4) #  m 
+      MICRON = (1e-6) #  m 
+      ANGSTROM = (1e-10) #  m 
+      HECTARE = (1e4) #  m^2 
+      ACRE = (4.04685642241e3) #  m^2 
+      BARN = (1e-28) #  m^2 
+      LITER = (1e-3) #  m^3 
+      US_GALLON = (3.78541178402e-3) #  m^3 
+      QUART = (9.46352946004e-4) #  m^3 
+      PINT = (4.73176473002e-4) #  m^3 
+      CUP = (2.36588236501e-4) #  m^3 
+      FLUID_OUNCE = (2.95735295626e-5) #  m^3 
+      TABLESPOON = (1.47867647813e-5) #  m^3 
+      TEASPOON = (4.92892159375e-6) #  m^3 
+      CANADIAN_GALLON = (4.54609e-3) #  m^3 
+      UK_GALLON = (4.546092e-3) #  m^3 
+      MILES_PER_HOUR = (4.4704e-1) #  m / s 
+      KILOMETERS_PER_HOUR = (2.77777777778e-1) #  m / s 
+      KNOT = (5.14444444444e-1) #  m / s 
+      POUND_MASS = (4.5359237e-1) #  kg 
+      OUNCE_MASS = (2.8349523125e-2) #  kg 
+      TON = (9.0718474e2) #  kg 
+      METRIC_TON = (1e3) #  kg 
+      UK_TON = (1.0160469088e3) #  kg 
+      TROY_OUNCE = (3.1103475e-2) #  kg 
+      CARAT = (2e-4) #  kg 
+      UNIFIED_ATOMIC_MASS = (1.660538782e-27) #  kg 
+      GRAM_FORCE = (9.80665e-3) #  kg m / s^2 
+      POUND_FORCE = (4.44822161526e0) #  kg m / s^2 
+      KILOPOUND_FORCE = (4.44822161526e3) #  kg m / s^2 
+      POUNDAL = (1.38255e-1) #  kg m / s^2 
+      CALORIE = (4.1868e0) #  kg m^2 / s^2 
+      BTU = (1.05505585262e3) #  kg m^2 / s^2 
+      THERM = (1.05506e8) #  kg m^2 / s^2 
+      HORSEPOWER = (7.457e2) #  kg m^2 / s^3 
+      BAR = (1e5) #  kg / m s^2 
+      STD_ATMOSPHERE = (1.01325e5) #  kg / m s^2 
+      TORR = (1.33322368421e2) #  kg / m s^2 
+      METER_OF_MERCURY = (1.33322368421e5) #  kg / m s^2 
+      INCH_OF_MERCURY = (3.38638815789e3) #  kg / m s^2 
+      INCH_OF_WATER = (2.490889e2) #  kg / m s^2 
+      PSI = (6.89475729317e3) #  kg / m s^2 
+      POISE = (1e-1) #  kg m^-1 s^-1 
+      STOKES = (1e-4) #  m^2 / s 
+      STILB = (1e4) #  cd / m^2 
+      LUMEN = (1e0) #  cd sr 
+      LUX = (1e0) #  cd sr / m^2 
+      PHOT = (1e4) #  cd sr / m^2 
+      FOOTCANDLE = (1.076e1) #  cd sr / m^2 
+      LAMBERT = (1e4) #  cd sr / m^2 
+      FOOTLAMBERT = (1.07639104e1) #  cd sr / m^2 
+      CURIE = (3.7e10) #  1 / s 
+      ROENTGEN = (2.58e-4) #  A s / kg 
+      RAD = (1e-2) #  m^2 / s^2 
+      SOLAR_MASS = (1.98892e30) #  kg 
+      BOHR_RADIUS = (5.291772083e-11) #  m 
+      NEWTON = (1e0) #  kg m / s^2 
+      DYNE = (1e-5) #  kg m / s^2 
+      JOULE = (1e0) #  kg m^2 / s^2 
+      ERG = (1e-7) #  kg m^2 / s^2 
+      STEFAN_BOLTZMANN_CONSTANT = (5.67040047374e-8) #  kg / K^4 s^3 
+      THOMSON_CROSS_SECTION = (6.65245893699e-29) #  m^2 
+      BOHR_MAGNETON = (9.27400899e-24) #  A m^2 
+      NUCLEAR_MAGNETON = (5.05078317e-27) #  A m^2 
+      ELECTRON_MAGNETIC_MOMENT = (9.28476362e-24) #  A m^2 
+      PROTON_MAGNETIC_MOMENT = (1.410606633e-26) #  A m^2 
+      FARADAY = (9.64853429775e4) #  A s / mol 
+      ELECTRON_CHARGE = (1.602176487e-19) #  A s 
+      VACUUM_PERMITTIVITY = (8.854187817e-12) #  A^2 s^4 / kg m^3 
+      VACUUM_PERMEABILITY = (1.25663706144e-6) #  kg m / A^2 s^2 
+      DEBYE = (3.33564095198e-30) #  A s^2 / m^2 
+      GAUSS = (1e-4) #  kg / A s^2 
+      def all_names
+        return ["SPEED_OF_LIGHT","GRAVITATIONAL_CONSTANT","PLANCKS_CONSTANT_H","PLANCKS_CONSTANT_HBAR","ASTRONOMICAL_UNIT","LIGHT_YEAR","PARSEC","GRAV_ACCEL","ELECTRON_VOLT","MASS_ELECTRON","MASS_MUON","MASS_PROTON","MASS_NEUTRON","RYDBERG","BOLTZMANN","MOLAR_GAS","STANDARD_GAS_VOLUME","MINUTE","HOUR","DAY","WEEK","INCH","FOOT","YARD","MILE","NAUTICAL_MILE","FATHOM","MIL","POINT","TEXPOINT","MICRON","ANGSTROM","HECTARE","ACRE","BARN","LITER","US_GALLON","QUART","PINT","CUP","FLUID_OUNCE","TABLESPOON","TEASPOON","CANADIAN_GALLON","UK_GALLON","MILES_PER_HOUR","KILOMETERS_PER_HOUR","KNOT","POUND_MASS","OUNCE_MASS","TON","METRIC_TON","UK_TON","TROY_OUNCE","CARAT","UNIFIED_ATOMIC_MASS","GRAM_FORCE","POUND_FORCE","KILOPOUND_FORCE","POUNDAL","CALORIE","BTU","THERM","HORSEPOWER","BAR","STD_ATMOSPHERE","TORR","METER_OF_MERCURY","INCH_OF_MERCURY","INCH_OF_WATER","PSI","POISE","STOKES","STILB","LUMEN","LUX","PHOT","FOOTCANDLE","LAMBERT","FOOTLAMBERT","CURIE","ROENTGEN","RAD","SOLAR_MASS","BOHR_RADIUS","NEWTON","DYNE","JOULE","ERG","STEFAN_BOLTZMANN_CONSTANT","THOMSON_CROSS_SECTION","BOHR_MAGNETON","NUCLEAR_MAGNETON","ELECTRON_MAGNETIC_MOMENT","PROTON_MAGNETIC_MOMENT","FARADAY","ELECTRON_CHARGE","VACUUM_PERMITTIVITY","VACUUM_PERMEABILITY","DEBYE","GAUSS"]
+      end
+    end
+  end
+end

data/lib/gsl4r/const_num.rb

@@ -0,0 +1,29 @@
+# Generated by gsl4r/bin/generate_consts.rb
+# from /opt/local/include/gsl/gsl_const_num.h
+module GSL4r
+  module PhysicalConstants
+    module NUM
+      FINE_STRUCTURE = (7.297352533e-3) #  1 
+      AVOGADRO = (6.02214199e23) #  1 / mol 
+      YOTTA = (1e24) #  1 
+      ZETTA = (1e21) #  1 
+      EXA = (1e18) #  1 
+      PETA = (1e15) #  1 
+      TERA = (1e12) #  1 
+      GIGA = (1e9) #  1 
+      MEGA = (1e6) #  1 
+      KILO = (1e3) #  1 
+      MILLI = (1e-3) #  1 
+      MICRO = (1e-6) #  1 
+      NANO = (1e-9) #  1 
+      PICO = (1e-12) #  1 
+      FEMTO = (1e-15) #  1 
+      ATTO = (1e-18) #  1 
+      ZEPTO = (1e-21) #  1 
+      YOCTO = (1e-24) #  1 
+      def all_names
+        return ["FINE_STRUCTURE","AVOGADRO","YOTTA","ZETTA","EXA","PETA","TERA","GIGA","MEGA","KILO","MILLI","MICRO","NANO","PICO","FEMTO","ATTO","ZEPTO","YOCTO"]
+      end
+    end
+  end
+end

data/lib/gsl4r/platform.rb

@@ -1,6 +1,7 @@
 #
-# This file is automatically modified at the
-# time of gem installation
+# TODO:
+# Have this file automatically modified at the
+# time of gem installation?
 #
 
 module GSL4r

data/lib/gsl4r/util.rb

@@ -7,18 +7,26 @@
 #
 
 require 'rubygems'
+require 'monitor'
 
 module GSL4r
   module Util
 
     $c_var_num = 0
 
-    def attach_gsl_function( method_name, args, return_var, args_type=nil, return_type=nil )
+    def attach_gsl_function( method_name, args, return_var, args_type=nil, return_type=nil,
+			    add_self=true )
 
       # This function is attached to the extended ::FFI::Library
       # module from the calling namespace, e.g. ::GSL4r::Complex::Methods
       attach_function method_name, args, return_var
 
+      # Give a hint to the current module if this method should add a copy
+      # of itself to the calling list to make calls convienent e.g. a.abs
+      self.class.class_eval <<-end_eval
+        ::#{self}::#{method_name.to_s.upcase}_ADD_SELF = #{add_self}
+      end_eval
+
       if ( args_type != nil )
         # prepare c and ruby args code
 	c_src = ""
@@ -72,6 +80,7 @@ module GSL4r
 
 	c_src << "  puts(" << %Q{\\"end\\"} << ");"
 
+	# TODO, create unit test for aliased/shorthand versions of methods
 
 	eval <<-end_eval
         def c_test_#{method_name}
@@ -80,6 +89,63 @@ module GSL4r
         end
 	end_eval
       end
-    end
-  end
-end
+    end # attach_gsl_function
+
+    module AutoPrefix 
+
+      $prefixLock = Monitor.new
+
+      # This traps method calls intended to create shortened versions
+      # of the GSL function calls.
+      # 
+      # This first checks if the called method matches the Module
+      # function call gsl_complex_#{called_method} (where called_method
+      # might be 'abs').
+      #
+      # If it finds a match (respond_to), it will then create a new
+      # method for the class as a whole (class_eval), making the method
+      # available to not just this instance of the class, but all
+      # existing instances and all those created after.
+      # 
+      # Finally, the creation is wrapped up in a synchronized call
+      # to ensure thread safety.  It is only unsafe the first time
+      # the method is invoked (and non-existent at that point).  Every
+      # time the method is invoked after, it should not hit method_missing.
+      # TODO: Is this true for java threads too, or is it per 'vm' per
+      # thread?
+      def method_missing( called_method, *args, &block )
+
+	$prefixLock.synchronize do
+
+	  prefix = self.class::GSL_PREFIX
+
+	  if ( self.class::GSL_MODULE::Methods.respond_to?("#{prefix}#{called_method}") == false )
+	    prefix = ""
+	    if ( self.class::GSL_MODULE::Methods.respond_to?("#{called_method}") == false )
+	      super # NoMethodError
+	    end
+	  end
+
+	  # TODO: this could be smoothed out with the #args/#parameters parts of
+	  # Ruby 1.9.
+	  # This could inspect the definition of the parameter and if the
+	  # first argument in the definition were of the same type as self
+	  # then self could be inserted into the args list per below
+	  # rather than requiring the #{called_method.to_s.upcase}_ADD_SELF
+	  # boolean definition and check
+	  self.class.class_eval <<-end_eval
+	  def #{called_method}(*args, &block)
+	    if ::#{self.class::GSL_MODULE.to_s}::Methods::#{prefix.to_s.upcase}#{called_method.to_s.upcase}_ADD_SELF 
+	      args.insert(0, self)
+	    end
+	    ::#{self.class::GSL_MODULE.to_s}::Methods::#{prefix}#{called_method}( *args, &block )
+	  end
+	  end_eval
+
+	  __send__(called_method, *args, &block)
+	end # prefixLock.synchronize
+      end # method_missing
+    end # AutoPrefix
+
+  end # Util
+end # GSL4r

data/lib/gsl4r/vector.rb

@@ -10,20 +10,25 @@ require 'rubygems'
 require 'ffi'
 
 module GSL4r
+  module Vector
 
-  extend ::FFI::Library
+    extend ::FFI::Library
 
-  ffi_lib 'gsl'
+    ffi_lib ::GSL4r::GSL_LIB_PATH
 
-  class Vector
-    attach_function :gsl_vector_alloc, [ :size_t ], :pointer
-    attach_function :gsl_vector_calloc, [ :size_t ], :pointer
-    attach_function :gsl_vector_free, [ :pointer ], :void
+    class GSL_Vector < ::FFI::Struct
+      layout :size,	:size_t,
+	:stride,	:size_t,
+	:data,	:pointer,
+	:block,	:pointer,
+	:owner,	:int
 
-    # initializing
-    attach_function :gsl_vector_set_all, [ :pointer, :double ], :void
-    attach_function :gsl_vector_set_zero, [ :pointer ], :void
-    attach_function :gsl_vector_set_basis, [ :pointer, :size_t ], :int
-  end
+      include ::GSL4r::Util::AutoPrefix
+      module ::GSL4r::Util::AutoPrefix
+	GSL_PREFIX = "gsl_vector_"
+	GSL_MODULE = ::GSL4r::Vector
+      end
 
-end
+    end # class GSL_Vector
+  end # module Vector
+end # module GSL4r

data/lib/t.rb

@@ -0,0 +1,10 @@
+include ::GSL4r::Complex
+a=GSL_Complex.create(1,1)
+
+a.gsl_complex_arccsc_real(5.0)
+a.arccsc_real(5.0)
+
+#a.gsl_complex_abs(a)
+#a.gsl_complex_abs()
+#a.abs()
+

data/test/README

@@ -0,0 +1,8 @@
+This directory is empty for now, as all tests are generated automatically by running:
+
+rake test
+
+This will create a C programs that make calls to GSL functions, then writing the
+results as Ruby programs that cross check the FFI based wrapper answers against
+the C programs' results using Test::Unit.
+