Image

head

code

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

unit class Math::Libgsl::DigitalFiltering:ver<0.0.2>:auth<zef:FRITH>;

use NativeCall;
use Math::Libgsl::Constants;
use Math::Libgsl::Exception;
use Math::Libgsl::Vector;
use Math::Libgsl::Vector::Int32;
use Math::Libgsl::Raw::DigitalFiltering;

class Gaussian {
  has gsl_filter_gaussian_workspace $.ws;

  multi method new(Int $size!) { self.bless(:$size) }
  multi method new(Int :$size!) { self.bless(:$size) }

  submethod BUILD(Int :$size!) { $!ws = gsl_filter_gaussian_alloc($size) }
  submethod DESTROY { gsl_filter_gaussian_free($!ws) }

  method filter(Num() $alpha!, Math::Libgsl::Vector $x!, Int :$order = 0, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Bool :$inplace? --> Math::Libgsl::Vector) {
    my Math::Libgsl::Vector $y;
    with $inplace {
      $y := $x;
    } else {
      $y .= new: $x.vector.size;
    }
    my num64 $α = $alpha;
    my $ret = gsl_filter_gaussian($endtype, $α, $order, $x.vector, $y.vector, $!ws);
    fail X::Libgsl.new: errno => $ret, error => "Can't filter data" if $ret ≠ GSL_SUCCESS;
    return $y;
  }

  method kernel(Num() $alpha!, Int $size, Int :$order = 0, Int :$normalize = 0 --> Math::Libgsl::Vector) {
    my Math::Libgsl::Vector $kernel .= new: $size;
    my num64 $α = $alpha;
    my $ret = gsl_filter_gaussian_kernel($α, $order, $normalize, $kernel.vector);
    fail X::Libgsl.new: errno => $ret, error => "Can't create a gaussian kernel" if $ret ≠ GSL_SUCCESS;
    return $kernel;
  }
}

class Median {
  has gsl_filter_median_workspace $.ws;

  multi method new(Int $size!) { self.bless(:$size) }
  multi method new(Int :$size!) { self.bless(:$size) }

  submethod BUILD(Int :$size!) { $!ws = gsl_filter_median_alloc($size) }
  submethod DESTROY { gsl_filter_median_free($!ws) }

  method filter(Math::Libgsl::Vector $x!, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Bool :$inplace? --> Math::Libgsl::Vector) {
    my Math::Libgsl::Vector $y;
    with $inplace {
      $y := $x;
    } else {
      $y .= new: $x.vector.size;
    }
    my $ret = gsl_filter_median($endtype, $x.vector, $y.vector, $!ws);
    fail X::Libgsl.new: errno => $ret, error => "Can't filter data" if $ret ≠ GSL_SUCCESS;
    return $y;
  }
}

class RMedian {
  has gsl_filter_rmedian_workspace $.ws;

  multi method new(Int $size!) { self.bless(:$size) }
  multi method new(Int :$size!) { self.bless(:$size) }

  submethod BUILD(Int :$size!) { $!ws = gsl_filter_rmedian_alloc($size) }
  submethod DESTROY { gsl_filter_rmedian_free($!ws) }

  method filter(Math::Libgsl::Vector $x!, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Bool :$inplace? --> Math::Libgsl::Vector) {
    my Math::Libgsl::Vector $y;
    with $inplace {
      $y := $x;
    } else {
      $y .= new: $x.vector.size;
    }
    my $ret = gsl_filter_rmedian($endtype, $x.vector, $y.vector, $!ws);
    fail X::Libgsl.new: errno => $ret, error => "Can't filter data" if $ret ≠ GSL_SUCCESS;
    return $y;
  }
}

class Impulse {
  has gsl_filter_impulse_workspace $.ws;

  multi method new(Int $size!) { self.bless(:$size) }
  multi method new(Int :$size!) { self.bless(:$size) }

  submethod BUILD(Int :$size!) { $!ws = gsl_filter_impulse_alloc($size) }
  submethod DESTROY { gsl_filter_impulse_free($!ws) }

  method filter(Math::Libgsl::Vector $x!, Num() $tuning, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Int :$scaletype = GSL_FILTER_SCALE_MAD, Bool :$inplace? --> List) {
    my Math::Libgsl::Vector $y;
    with $inplace {
      $y := $x;
    } else {
      $y .= new: $x.vector.size;
    }
    my Math::Libgsl::Vector        $xmedian  .= new: $x.vector.size;
    my Math::Libgsl::Vector        $xsigma   .= new: $x.vector.size;
    my Math::Libgsl::Vector::Int32 $ioutlier .= new: $x.vector.size;
    my num64 $t = $tuning;
    my size_t $noutlier;
    my $ret = gsl_filter_impulse($endtype, $scaletype, $t, $x.vector, $y.vector, $xmedian.vector, $xsigma.vector, $noutlier, $ioutlier.vector, $!ws);
    fail X::Libgsl.new: errno => $ret, error => "Can't filter data" if $ret ≠ GSL_SUCCESS;
    return $xmedian, $xsigma, $noutlier, $ioutlier, $y;
  }
}



![Impulse filter](examples/04-impulse.svg)


Math::Libgsl::DigitalFiltering -  An interface to libgsl, the Gnu Scientific Library - Digital Filtering


=begin code :lang<raku>

use Math::Libgsl::Vector;
use Math::Libgsl::DigitalFiltering;

my constant $N = 1000;
my constant $K = 21;
my Math::Libgsl::Vector $x .= new: :size($N);
$x.scanf('data.dat');
my Math::Libgsl::DigitalFiltering::Gaussian $gauss .= new: :size($K);
my $y = $gauss.filter(2.5, $x);

=end code


Math::Libgsl::DigitalFiltering is an interface to the Digital Filtering functions of libgsl, the Gnu Scientific Library.


item

each encapsulates the methods and the buffers needed to create and use the filter on the data stored in a Math::Libgsl::Vector object.


Math::Libgsl::DigitalFiltering::Gaussian


This class encapsulate a Gaussian filter.


The constructor accepts one simple or named argument: the kernel size.


filter(Num() $alpha!, Math::Libgsl::Vector $x!, Int :$order = 0, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Bool :$inplace? --> Math::Libgsl::Vector)


This method applies a Gaussian filter parameterized by B<$alpha> to the input vector B<$x>.
The optional named argument B<:$order> specifies the derivative order, with C<0> corresponding to a Gaussian, C<1> corresponding to a first derivative Gaussian, and so on.
The optional named argument B<:$endtype> specifies how the signal end points are handled. The symbolic names for this argument are listed in the Math::Libgsl::Constants module as follows:


The boolean named argument B<:$inplace> directs the method to apply the filter in-place.
This method returns the filter output as a B<Math::Libgsl::Vector> object.


kernel(Num() $alpha!, Int $size, Int :$order = 0, Int :$normalize = 0 --> Math::Libgsl::Vector)


This method constructs a Gaussian kernel parameterized by B<$alpha>, of size B<$size>.
The optional named argument B<:$order> specifies the derivative order.
The optional named argument B<:$normalize> specifies if the kernel is to be normalized to sum to one on output.
This method returns the filter output as a B<Math::Libgsl::Vector> object.


filter(Math::Libgsl::Vector $x!, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Bool :$inplace? --> Math::Libgsl::Vector)


This method applies a Median filter to the input vector B<$x>.
The optional named argument B<:$endtype> specifies how the signal end points are handled.
The optional boolean named argument B<:$inplace> directs the method to apply the filter in-place.
This method returns the filter output as a B<Math::Libgsl::Vector> object.


This class encapsulate a recursive Median filter.


This class encapsulate an Impulse detection filter.


filter(Math::Libgsl::Vector $x!, Num() $tuning, Int :$endtype = GSL_MOVSTAT_END_PADZERO, Int :$scaletype = GSL_FILTER_SCALE_MAD, Bool :$inplace? --> List)


This method applies an Impulse filter to the input vector B<$x>, using the tuning parameter B<$tuning>.
The optional named argument B<:$endtype> specifies how the signal end points are handled.
The optional named argument B<:$scaletype> specifies how the scale estimate Sₙ of the window is calculated. The symbolic names for this argument are listed in the Math::Libgsl::Constants module as follows:


The optional boolean named argument B<:$inplace> directs the method to apply the filter in-place.
This method returns a List of values:


For more details on libgsl see L<https://www.gnu.org/software/gsl/>.
The excellent C Library manual is available here L<https://www.gnu.org/software/gsl/doc/html/index.html>, or here L<https://www.gnu.org/software/gsl/doc/latex/gsl-ref.pdf> in PDF format.


This module requires the libgsl library to be installed. Please follow the instructions below based on your platform:


=begin code
sudo apt install libgsl23 libgsl-dev libgslcblas0
=end code


That command will install libgslcblas0 as well, since it's used by the GSL.


libgsl23 and libgslcblas0 have a missing symbol on Ubuntu 18.04.
I solved the issue installing the Debian Buster version of those three libraries:


DigitalFiltering

use v6;

unit module Math::Libgsl::Constants:ver<0.0.12>:auth<zef:FRITH>;

use NativeCall;

sub LIB {
  run('/sbin/ldconfig', '-p', :chomp, :out)
    .out
    .slurp(:close)
    .split("\n")
    .grep(/^ \s+ libgsl\.so\. \d+ /)
    .sort
    .head
    .comb(/\S+/)
    .head;
}

our $gsl-version is export = cglobal(&LIB, 'gsl_version', Str).Version;

constant GSL_PREC_DOUBLE  is export = 0; # Accuracy ≅ 2 * 10⁻¹⁶
constant GSL_PREC_SINGLE  is export = 1; # Accuracy ≅ 10⁻⁷
constant GSL_PREC_APPROX  is export = 2; # Accuracy ≅ 5 * 10⁻⁴
constant GSL_MODE_DEFAULT is export = 0;

enum gsl_sf_legendre_t is export <
  GSL_SF_LEGENDRE_SCHMIDT
  GSL_SF_LEGENDRE_SPHARM
  GSL_SF_LEGENDRE_FULL
  GSL_SF_LEGENDRE_NONE
>;

enum gsl-error is export (
  GSL_SUCCESS  =>  0,
  GSL_FAILURE  => -1,
  GSL_CONTINUE => -2,   # iteration has not converged
  GSL_EDOM     =>  1,   # input domain error, e.g sqrt(-1)
  GSL_ERANGE   =>  2,   # output range error, e.g. exp(1e100)
  GSL_EFAULT   =>  3,   # invalid pointer
  GSL_EINVAL   =>  4,   # invalid argument supplied by user
  GSL_EFAILED  =>  5,   # generic failure
  GSL_EFACTOR  =>  6,   # factorization failed
  GSL_ESANITY  =>  7,   # sanity check failed - shouldn't happen
  GSL_ENOMEM   =>  8,   # malloc failed
  GSL_EBADFUNC =>  9,   # problem with user-supplied function
  GSL_ERUNAWAY =>  10,  # iterative process is out of control
  GSL_EMAXITER =>  11,  # exceeded max number of iterations
  GSL_EZERODIV =>  12,  # tried to divide by zero
  GSL_EBADTOL  =>  13,  # user specified an invalid tolerance
  GSL_ETOL     =>  14,  # failed to reach the specified tolerance
  GSL_EUNDRFLW =>  15,  # underflow
  GSL_EOVRFLW  =>  16,  # overflow
  GSL_ELOSS    =>  17,  # loss of accuracy
  GSL_EROUND   =>  18,  # failed because of roundoff error
  GSL_EBADLEN  =>  19,  # matrix, vector lengths are not conformant
  GSL_ENOTSQR  =>  20,  # matrix not square
  GSL_ESING    =>  21,  # apparent singularity detected
  GSL_EDIVERGE =>  22,  # integral or series is divergent
  GSL_EUNSUP   =>  23,  # requested feature is not supported by the hardware
  GSL_EUNIMPL  =>  24,  # requested feature not (yet) implemented
  GSL_ECACHE   =>  25,  # cache limit exceeded
  GSL_ETABLE   =>  26,  # table limit exceeded
  GSL_ENOPROG  =>  27,  # iteration is not making progress towards solution
  GSL_ENOPROGJ =>  28,  # jacobian evaluations are not improving the solution
  GSL_ETOLF    =>  29,  # cannot reach the specified tolerance in F
  GSL_ETOLX    =>  30,  # cannot reach the specified tolerance in X
  GSL_ETOLG    =>  31,  # cannot reach the specified tolerance in gradient
  GSL_EOF      =>  32   # end of file
);

constant GSL_SF_FACT_NMAX is export = 170; # Max n such that gsl_sf_fact(n) does not give an overflow
constant GSL_SF_DOUBLEFACT_NMAX is export = 297; # Max n such that gsl_sf_doublefact(n) does not give an overflow.

enum cblas-order     is export ( CblasRowMajor => 101, CblasColMajor => 102 );
enum cblas-transpose is export ( CblasNoTrans => 111, CblasTrans => 112, CblasConjTrans => 113 );
enum cblas-uplo      is export ( CblasUpper => 121, CblasLower => 122 );
enum cblas-diag      is export ( CblasNonUnit => 131, CblasUnit => 132 );
enum cblas-side      is export ( CblasLeft => 141, CblasRight => 142 );

enum RngType is export <BOROSH13 COVEYOU CMRG FISHMAN18 FISHMAN20 FISHMAN2X GFSR4 KNUTHRAN KNUTHRAN2 KNUTHRAN2002
  LECUYER21 MINSTD MRG MT19937 MT19937_1999 MT19937_1998 R250 RAN0 RAN1 RAN2 RAN3 RAND RAND48 RANDOM128_BSD
  RANDOM128_GLIBC2 RANDOM128_LIBC5 RANDOM256_BSD RANDOM256_GLIBC2 RANDOM256_LIBC5 RANDOM32_BSD RANDOM32_GLIBC2
  RANDOM32_LIBC5 RANDOM64_BSD RANDOM64_GLIBC2 RANDOM64_LIBC5 RANDOM8_BSD RANDOM8_GLIBC2 RANDOM8_LIBC5 RANDOM_BSD
  RANDOM_GLIBC2 RANDOM_LIBC5 RANDU RANF RANLUX RANLUX389 RANLXD1 RANLXD2 RANLXS0 RANLXS1 RANLXS2 RANMAR SLATEC
  TAUS TAUS2 TAUS113 TRANSPUTER TT800 UNI UNI32 VAX WATERMAN14 ZUF DEFAULT>;

enum QRngType is export <NIEDERREITER2 SOBOL HALTON REVERSEHALTON>;

enum gsl_movstat_end_t is export <
  GSL_MOVSTAT_END_PADZERO
  GSL_MOVSTAT_END_PADVALUE
  GSL_MOVSTAT_END_TRUNCATE
>;

enum gsl_filter_end_t is export <
  GSL_FILTER_END_PADZERO
  GSL_FILTER_END_PADVALUE
  GSL_FILTER_END_TRUNCATE
>;

enum gsl_filter_scale_t is export <
  GSL_FILTER_SCALE_MAD
  GSL_FILTER_SCALE_IQR
  GSL_FILTER_SCALE_SN
  GSL_FILTER_SCALE_QN
>;

enum gsl_eigen_sort_t is export <
  GSL_EIGEN_SORT_VAL_ASC
  GSL_EIGEN_SORT_VAL_DESC
  GSL_EIGEN_SORT_ABS_ASC
  GSL_EIGEN_SORT_ABS_DESC
>;

enum InterpType1D is export <LINEAR POLYNOMIAL CSPLINE CSPLINE_PERIODIC AKIMA AKIMA_PERIODIC STEFFEN>;
enum InterpType2D is export <BILINEAR BICUBIC>;



Math::Libgsl::Constants - An interface to libgsl, the Gnu Scientific Library - constants and exceptions.


=begin code :lang<raku>

use Math::Libgsl::Constants;
use Math::Libgsl::Exception;

=end code


This module provides the constants and the exception class used by all the other modules.


From v0.0.11 the version variable C<$gsl-version> is a C<Version> object.


To install it using zef (a module management tool):


=begin code
$ zef install Math::Libgsl::Constants
=end code


Fernando Santagata <nando.santagata@gmail.com>


This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.


Constants

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

NAME

SYNOPSIS

DESCRIPTION

CHANGES

Installation

AUTHOR

COPYRIGHT AND LICENSE

Math::Libgsl::Constants v0.0.12

Authors

License

Dependencies

Test Dependencies

Provides

Documentation