require 'statsample/regression/simple'
require 'statsample/regression/multiple'

require 'statsample/regression/multiple/matrixengine'
require 'statsample/regression/multiple/rubyengine'
require 'statsample/regression/multiple/gslengine'

require 'statsample/regression/binomial'
require 'statsample/regression/binomial/logit'
require 'statsample/regression/binomial/probit'

module Statsample
    # = Module for regression procedures.
    # Use the method on this class to generate
    # analysis.
    # If you need more control, you can
    # create and control directly the objects who computes
    # the regressions.
    # 
    # * Simple Regression :  Statsample::Regression::Simple
    # * Multiple Regression: Statsample::Regression::Multiple
    # * Logit Regression:    Statsample::Regression::Binomial::Logit
    # * Probit Regression:    Statsample::Regression::Binomial::Probit
    module Regression
      # Create a Statsample::Regression::Simple object, for simple regression
      # * x: independent Vector
      # * y: dependent Vector
      # <b>Usage:</b>
      #   x=100.times.collect {|i| rand(100)}.to_scale
      #   y=100.times.collect {|i| 2+x[i]*2+rand()}.to_scale
      #   sr=Statsample::Regression.simple(x,y)
      #   sr.a
      #   => 2.51763295177808
      #   sr.b
      #   => 1.99973746599856
      #   sr.r
      #   => 0.999987881153254

      def self.simple(x,y)
        Statsample::Regression::Simple.new_from_vectors(x,y)
      end
      # Create a Binomial::Logit object, for logit regression.
      # * ds:: Dataset
      # * y::  Name of dependent vector
      # <b>Usage</b>
      #   dataset=Statsample::CSV.read("data.csv")
      #   lr=Statsample::Regression.logit(dataset,'y')
      #   
      def self.logit(ds,y_var)
        Statsample::Regression::Binomial::Logit.new(ds,y_var)                
      end
      # Create a Binomial::Probit object, for probit regression
      # * ds:: Dataset
      # * y::  Name of dependent vector
      # <b>Usage</b>
      #   dataset=Statsample::CSV.read("data.csv")
      #   lr=Statsample::Regression.probit(dataset,'y')
      #   
      
      def self.probit(ds,y_var)
        Statsample::Regression::Binomial::Probit.new(ds,y_var)                
      end
      
      
      # Creates one of the Statsample::Regression::Multiple object,
      # for OLS multiple regression.
      # Parameters:
      # * ds: Dataset.
      # * y: Name of dependent variable.
      # * missing_data: Could be
      #   * :listwise: delete cases with one or more empty data (default).
      #   * :pairwise: uses correlation matrix. Use with caution.
      # 
      # <b>Usage:</b>
      #   lr=Statsample::Regression::multiple(ds,'y')
      def self.multiple(ds,y_var, missing_data=:listwise)
        if missing_data==:pairwise
           RubyEngine.new(ds,y_var)
        else
          if Statsample.has_gsl?
            Statsample::Regression::Multiple::GslEngine.new(ds, y_var)
          else
            ds2=ds.dup_only_valid
            Statsample::Regression::Multiple::RubyEngine.new(ds2,y_var)
          end
        end
      end
    end
end