# This file was automatically generated by SWIG (https://www.swig.org).
# Version 4.2.0
#
# Do not make changes to this file unless you know what you are doing - modify
# the SWIG interface file instead.

package Math::GSL::BSpline;
use base qw(Exporter);
use base qw(DynaLoader);
package Math::GSL::BSplinec;
bootstrap Math::GSL::BSpline;
package Math::GSL::BSpline;
@EXPORT = qw();

# ---------- BASE METHODS -------------

package Math::GSL::BSpline;

sub TIEHASH {
    my ($classname,$obj) = @_;
    return bless $obj, $classname;
}

sub CLEAR { }

sub FIRSTKEY { }

sub NEXTKEY { }

sub FETCH {
    my ($self,$field) = @_;
    my $member_func = "swig_${field}_get";
    $self->$member_func();
}

sub STORE {
    my ($self,$field,$newval) = @_;
    my $member_func = "swig_${field}_set";
    $self->$member_func($newval);
}

sub this {
    my $ptr = shift;
    return tied(%$ptr);
}


# ------- FUNCTION WRAPPERS --------

package Math::GSL::BSpline;

*gsl_error = *Math::GSL::BSplinec::gsl_error;
*gsl_stream_printf = *Math::GSL::BSplinec::gsl_stream_printf;
*gsl_strerror = *Math::GSL::BSplinec::gsl_strerror;
*gsl_set_error_handler = *Math::GSL::BSplinec::gsl_set_error_handler;
*gsl_set_error_handler_off = *Math::GSL::BSplinec::gsl_set_error_handler_off;
*gsl_set_stream_handler = *Math::GSL::BSplinec::gsl_set_stream_handler;
*gsl_set_stream = *Math::GSL::BSplinec::gsl_set_stream;
*gsl_bspline_alloc = *Math::GSL::BSplinec::gsl_bspline_alloc;
*gsl_bspline_free = *Math::GSL::BSplinec::gsl_bspline_free;
*gsl_bspline_ncoeffs = *Math::GSL::BSplinec::gsl_bspline_ncoeffs;
*gsl_bspline_order = *Math::GSL::BSplinec::gsl_bspline_order;
*gsl_bspline_nbreak = *Math::GSL::BSplinec::gsl_bspline_nbreak;
*gsl_bspline_breakpoint = *Math::GSL::BSplinec::gsl_bspline_breakpoint;
*gsl_bspline_greville_abscissa = *Math::GSL::BSplinec::gsl_bspline_greville_abscissa;
*gsl_bspline_knots = *Math::GSL::BSplinec::gsl_bspline_knots;
*gsl_bspline_knots_uniform = *Math::GSL::BSplinec::gsl_bspline_knots_uniform;
*gsl_bspline_knots_greville = *Math::GSL::BSplinec::gsl_bspline_knots_greville;
*gsl_bspline_eval = *Math::GSL::BSplinec::gsl_bspline_eval;

############# Class : Math::GSL::BSpline::gsl_function_struct ##############

package Math::GSL::BSpline::gsl_function_struct;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::BSpline );
%OWNER = ();
%ITERATORS = ();
*swig_function_get = *Math::GSL::BSplinec::gsl_function_struct_function_get;
*swig_function_set = *Math::GSL::BSplinec::gsl_function_struct_function_set;
*swig_params_get = *Math::GSL::BSplinec::gsl_function_struct_params_get;
*swig_params_set = *Math::GSL::BSplinec::gsl_function_struct_params_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::BSplinec::new_gsl_function_struct(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::BSplinec::delete_gsl_function_struct($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


############# Class : Math::GSL::BSpline::gsl_function_fdf_struct ##############

package Math::GSL::BSpline::gsl_function_fdf_struct;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::BSpline );
%OWNER = ();
%ITERATORS = ();
*swig_f_get = *Math::GSL::BSplinec::gsl_function_fdf_struct_f_get;
*swig_f_set = *Math::GSL::BSplinec::gsl_function_fdf_struct_f_set;
*swig_df_get = *Math::GSL::BSplinec::gsl_function_fdf_struct_df_get;
*swig_df_set = *Math::GSL::BSplinec::gsl_function_fdf_struct_df_set;
*swig_fdf_get = *Math::GSL::BSplinec::gsl_function_fdf_struct_fdf_get;
*swig_fdf_set = *Math::GSL::BSplinec::gsl_function_fdf_struct_fdf_set;
*swig_params_get = *Math::GSL::BSplinec::gsl_function_fdf_struct_params_get;
*swig_params_set = *Math::GSL::BSplinec::gsl_function_fdf_struct_params_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::BSplinec::new_gsl_function_fdf_struct(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::BSplinec::delete_gsl_function_fdf_struct($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


############# Class : Math::GSL::BSpline::gsl_function_vec_struct ##############

package Math::GSL::BSpline::gsl_function_vec_struct;
use vars qw(@ISA %OWNER %ITERATORS %BLESSEDMEMBERS);
@ISA = qw( Math::GSL::BSpline );
%OWNER = ();
%ITERATORS = ();
*swig_function_get = *Math::GSL::BSplinec::gsl_function_vec_struct_function_get;
*swig_function_set = *Math::GSL::BSplinec::gsl_function_vec_struct_function_set;
*swig_params_get = *Math::GSL::BSplinec::gsl_function_vec_struct_params_get;
*swig_params_set = *Math::GSL::BSplinec::gsl_function_vec_struct_params_set;
sub new {
    my $pkg = shift;
    my $self = Math::GSL::BSplinec::new_gsl_function_vec_struct(@_);
    bless $self, $pkg if defined($self);
}

sub DESTROY {
    return unless $_[0]->isa('HASH');
    my $self = tied(%{$_[0]});
    return unless defined $self;
    delete $ITERATORS{$self};
    if (exists $OWNER{$self}) {
        Math::GSL::BSplinec::delete_gsl_function_vec_struct($self);
        delete $OWNER{$self};
    }
}

sub DISOWN {
    my $self = shift;
    my $ptr = tied(%$self);
    delete $OWNER{$ptr};
}

sub ACQUIRE {
    my $self = shift;
    my $ptr = tied(%$self);
    $OWNER{$ptr} = 1;
}


# ------- VARIABLE STUBS --------

package Math::GSL::BSpline;

*GSL_VERSION = *Math::GSL::BSplinec::GSL_VERSION;
*GSL_MAJOR_VERSION = *Math::GSL::BSplinec::GSL_MAJOR_VERSION;
*GSL_MINOR_VERSION = *Math::GSL::BSplinec::GSL_MINOR_VERSION;
*GSL_POSZERO = *Math::GSL::BSplinec::GSL_POSZERO;
*GSL_NEGZERO = *Math::GSL::BSplinec::GSL_NEGZERO;
*GSL_SUCCESS = *Math::GSL::BSplinec::GSL_SUCCESS;
*GSL_FAILURE = *Math::GSL::BSplinec::GSL_FAILURE;
*GSL_CONTINUE = *Math::GSL::BSplinec::GSL_CONTINUE;
*GSL_EDOM = *Math::GSL::BSplinec::GSL_EDOM;
*GSL_ERANGE = *Math::GSL::BSplinec::GSL_ERANGE;
*GSL_EFAULT = *Math::GSL::BSplinec::GSL_EFAULT;
*GSL_EINVAL = *Math::GSL::BSplinec::GSL_EINVAL;
*GSL_EFAILED = *Math::GSL::BSplinec::GSL_EFAILED;
*GSL_EFACTOR = *Math::GSL::BSplinec::GSL_EFACTOR;
*GSL_ESANITY = *Math::GSL::BSplinec::GSL_ESANITY;
*GSL_ENOMEM = *Math::GSL::BSplinec::GSL_ENOMEM;
*GSL_EBADFUNC = *Math::GSL::BSplinec::GSL_EBADFUNC;
*GSL_ERUNAWAY = *Math::GSL::BSplinec::GSL_ERUNAWAY;
*GSL_EMAXITER = *Math::GSL::BSplinec::GSL_EMAXITER;
*GSL_EZERODIV = *Math::GSL::BSplinec::GSL_EZERODIV;
*GSL_EBADTOL = *Math::GSL::BSplinec::GSL_EBADTOL;
*GSL_ETOL = *Math::GSL::BSplinec::GSL_ETOL;
*GSL_EUNDRFLW = *Math::GSL::BSplinec::GSL_EUNDRFLW;
*GSL_EOVRFLW = *Math::GSL::BSplinec::GSL_EOVRFLW;
*GSL_ELOSS = *Math::GSL::BSplinec::GSL_ELOSS;
*GSL_EROUND = *Math::GSL::BSplinec::GSL_EROUND;
*GSL_EBADLEN = *Math::GSL::BSplinec::GSL_EBADLEN;
*GSL_ENOTSQR = *Math::GSL::BSplinec::GSL_ENOTSQR;
*GSL_ESING = *Math::GSL::BSplinec::GSL_ESING;
*GSL_EDIVERGE = *Math::GSL::BSplinec::GSL_EDIVERGE;
*GSL_EUNSUP = *Math::GSL::BSplinec::GSL_EUNSUP;
*GSL_EUNIMPL = *Math::GSL::BSplinec::GSL_EUNIMPL;
*GSL_ECACHE = *Math::GSL::BSplinec::GSL_ECACHE;
*GSL_ETABLE = *Math::GSL::BSplinec::GSL_ETABLE;
*GSL_ENOPROG = *Math::GSL::BSplinec::GSL_ENOPROG;
*GSL_ENOPROGJ = *Math::GSL::BSplinec::GSL_ENOPROGJ;
*GSL_ETOLF = *Math::GSL::BSplinec::GSL_ETOLF;
*GSL_ETOLX = *Math::GSL::BSplinec::GSL_ETOLX;
*GSL_ETOLG = *Math::GSL::BSplinec::GSL_ETOLG;
*GSL_EOF = *Math::GSL::BSplinec::GSL_EOF;
*GSL_DISABLE_DEPRECATED = *Math::GSL::BSplinec::GSL_DISABLE_DEPRECATED;
*M_E = *Math::GSL::BSplinec::M_E;
*M_LOG2E = *Math::GSL::BSplinec::M_LOG2E;
*M_LOG10E = *Math::GSL::BSplinec::M_LOG10E;
*M_SQRT2 = *Math::GSL::BSplinec::M_SQRT2;
*M_SQRT1_2 = *Math::GSL::BSplinec::M_SQRT1_2;
*M_SQRT3 = *Math::GSL::BSplinec::M_SQRT3;
*M_PI = *Math::GSL::BSplinec::M_PI;
*M_PI_2 = *Math::GSL::BSplinec::M_PI_2;
*M_PI_4 = *Math::GSL::BSplinec::M_PI_4;
*M_SQRTPI = *Math::GSL::BSplinec::M_SQRTPI;
*M_2_SQRTPI = *Math::GSL::BSplinec::M_2_SQRTPI;
*M_1_PI = *Math::GSL::BSplinec::M_1_PI;
*M_2_PI = *Math::GSL::BSplinec::M_2_PI;
*M_LN10 = *Math::GSL::BSplinec::M_LN10;
*M_LN2 = *Math::GSL::BSplinec::M_LN2;
*M_LNPI = *Math::GSL::BSplinec::M_LNPI;
*M_EULER = *Math::GSL::BSplinec::M_EULER;

@EXPORT_OK = qw/
               gsl_bspline_alloc
               gsl_bspline_free
               gsl_bspline_ncoeffs
               gsl_bspline_order
               gsl_bspline_nbreak
               gsl_bspline_breakpoint
               gsl_bspline_knots
               gsl_bspline_knots_uniform
               gsl_bspline_eval
             /;
%EXPORT_TAGS = ( all => [ @EXPORT_OK ] );

__END__

=encoding utf8

=head1 NAME

Math::GSL::BSpline - Functions for the computation of smoothing basis splines

=head1 SYNOPSIS

    use Math::GSL::BSpline qw/:all/;

=head1 DESCRIPTION

=over

=item gsl_bspline_alloc($k, $nbreak)

This function allocates a workspace for computing B-splines of order $k. The
number of breakpoints is given by $nbreak. This leads to n = $nbreak + $k - 2
basis functions. Cubic B-splines are specified by $k = 4.

=item gsl_bspline_free($w)

This function frees the memory associated with the workspace $w.

=item gsl_bspline_ncoeffs($w)

This function returns the number of B-spline coefficients given by n = nbreak + k - 2.

=item gsl_bspline_order

=item gsl_bspline_nbreak

=item gsl_bspline_breakpoint

=item gsl_bspline_knots($breakpts, $w)

This function computes the knots associated with the given breakpoints inside
the vector $breakpts and stores them internally in $w->{knots}.

=item gsl_bspline_knots_uniform($a, $b, $w)

This function assumes uniformly spaced breakpoints on [$a,$b] and constructs
the corresponding knot vector using the previously specified nbreak parameter.
The knots are stored in $w->{knots}.

=item gsl_bspline_eval($x, $B, $w)

This function evaluates all B-spline basis functions at the position $x and
stores them in the vector $B, so that the ith element of $B is B_i($x). $B must
be of length n = $nbreak + $k - 2. This value may also be obtained by calling
gsl_bspline_ncoeffs. It is far more efficient to compute all of the basis
functions at once than to compute them individually, due to the nature of the
defining recurrence relation.

For more information on the functions, we refer you to the GSL official documentation:
http://www.gnu.org/software/gsl/manual/html_node/

=back

=head1 EXAMPLES

Coming soon.

=head1 AUTHORS

Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2024 Jonathan "Duke" Leto and Thierry Moisan

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;