;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2024 Rodion Goritskov <rodion.goritskov@gmail.com>
;;; Copyright © 2024 Sharlatan Hellseher <sharlatanus@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages golang-maths)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix build-system go)
  #:use-module (guix gexp)
  #:use-module (guix utils)
  #:use-module (guix git-download)
  #:use-module (guix packages)
  #:use-module (gnu packages)
  #:use-module (gnu packages golang)
  #:use-module (gnu packages golang-build)
  #:use-module (gnu packages golang-compression))

;;; Commentary:
;;;
;;; Please: Try to add new module packages in alphabetic order.
;;;
;;; Code:

;;;
;;; Libraries:
;;;

(define-public go-github-com-aclements-go-gg
  (package
    (name "go-github-com-aclements-go-gg")
    (version "0.0.0-20170323211221-abd1f791f5ee")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/aclements/go-gg")
             (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "06vda3fvhyavwdcbch591v64ds8jdb1v56c8rjv8qbd6g65ky383"))))
    (build-system go-build-system)
    (arguments
     (list
      #:skip-build? #t
      #:tests? #f
      #:import-path "github.com/aclements/go-gg"))
    (propagated-inputs
     (list go-github-com-aclements-go-moremath))
    (home-page "https://github.com/aclements/go-gg")
    (synopsis "Plotting package for Golang")
    (description
     "gg is a plotting package for Go inspired by the Grammar of Graphics.")
    (license license:bsd-3)))

(define-public go-codeberg-org-astronexus-brahe
  (package
    (name "go-codeberg-org-astronexus-brahe")
    (version "0.0.3")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://codeberg.org/astronexus/brahe.git")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1602xfla22rqhd6b98cbwklpcj7dmzjxywcnq3fajrsgx0ysf8p6"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "codeberg.org/astronexus/brahe"))
    (propagated-inputs (list go-gonum-org-v1-gonum))
    (home-page "https://codeberg.org/astronexus/brahe")
    (synopsis "Read and use data from the Augmented Tycho-HYG (AT-HYG) star catalog")
    (description
     "Package brahe defines core variable types and basic utility functions
for astronomy programs using the AT-HYG (Augmented Tycho-HYG) catalog.  The
base file (brahe.go) defines the most widely used types in these utility
functions. @code{brahe} uses the
@code{https://pkg.go.dev/gonum.org/v1/gonum/floats, Gonum floating point
library} for vector math.")
    (license license:expat)))

(define-public go-github-com-aclements-go-moremath
  (package
    (name "go-github-com-aclements-go-moremath")
    (version "0.0.0-20241023150245-c8bbc672ef66")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/aclements/go-moremath")
             (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "01c9fkjs6gx7z6qkzy9qld7q3jhi9vgqhk8ymqck3ccmhg9bh1nq"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/aclements/go-moremath"
      #:phases
      #~(modify-phases %standard-phases
          ;; No Go files in project root.
          (delete 'build))))
    (propagated-inputs
     (list go-gonum-org-v1-gonum))
    (home-page "https://github.com/aclements/go-moremath")
    (synopsis "Assortment of more specialized math routines for Golang")
    (description
     "These packages provide more specialized math routines than are available
in the standard Go @code{math} package.  go-moremath currently focuses on
statistical routines, with particular focus on high-quality implementations
and APIs for non-parametric methods.")
    (license license:bsd-3)))

(define-public go-github-com-cockroachdb-apd
  (package
    (name "go-github-com-cockroachdb-apd")
    (version "1.1.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/cockroachdb/apd")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "14jnnqpdsa3vxh2zpznd2dpnychcrlkljppfplrigrs245slyh72"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/cockroachdb/apd"
      #:test-flags #~(list "-skip" "TestFormatFlags/.*010G")))
    (propagated-inputs
     (list go-github-com-pkg-errors))
    (home-page "https://github.com/cockroachdb/apd")
    (synopsis "Arbitrary-precision decimals for Golang")
    (description
     "This package implements much of the decimal specification from the
@url{http://speleotrove.com/decimal/,General Decimal Arithmetic} description.
This is the same specification implemented by
@url{https://docs.python.org/2/library/decimal.html,Python’s decimal module}
and GCC’s decimal extension.")
    (license license:asl2.0)))

(define-public go-github-com-cockroachdb-apd-v3
  (package
    (inherit go-github-com-cockroachdb-apd)
    (name "go-github-com-cockroachdb-apd-v3")
    (version "3.2.1")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/cockroachdb/apd")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1jrb43l80mr8q1hx8q4p54rld6kya886ackv5yzqyhhhl271rnm6"))))
    (arguments
     (substitute-keyword-arguments
         (package-arguments go-github-com-cockroachdb-apd)
       ((#:import-path _) "github.com/cockroachdb/apd/v3")))))

(define-public go-github-com-johncgriffin-overflow
  (package
    (name "go-github-com-johncgriffin-overflow")
    (version "0.0.0-20211019200055-46fa312c352c")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/JohnCGriffin/overflow")
             (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1g4sfhdmzjl5vr16lfv7nv042w8dbz608bwzyvf7xlw4i7ypjjpq"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/JohnCGriffin/overflow"
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'generate-impl
            ;; Note that because Go has no template types, the majority of
            ;; repetitive code is generated by overflow_template.sh.  If you
            ;; have to change an algorithm, change it there and regenerate the
            ;; Go code.
            (lambda* (#:key import-path #:allow-other-keys)
              (with-directory-excursion (string-append "src/" import-path)
                (substitute* "overflow_template.sh"
                  (("/bin/sh") (which "sh")))
                (make-file-writable "overflow_impl.go")
                (invoke "./overflow_template.sh")
                (invoke "go" "generate")))))))
    (home-page "https://github.com/JohnCGriffin/overflow")
    (synopsis "Check for int/int64/int32 arithmetic overflow in Golang")
    (description
     "This package offers overflow-checked integer arithmetic operations for
@code{int},@code{int32}, and @code{int64}.  Each of the operations returns a
@code{result,bool} combination.  This was prompted by the need to know when to
flow into higher precision types from the @code{math.big} library.")
    ;; It's in README, see <https://github.com/JohnCGriffin/overflow/pull/5>.
    (license license:expat)))

(define-public go-github-com-kshedden-dstream
  (package
    (name "go-github-com-kshedden-dstream")
    (version "0.0.0-20190512025041-c4c410631beb")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/kshedden/dstream")
              (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0y9h5izl6s74kh7wlikagfl0mvsgmhn9m5fch3zpchjnx9m8307l"))))
    (build-system go-build-system)
    (arguments
     (list
      #:skip-build? #t
      #:import-path "github.com/kshedden/dstream"))
    (propagated-inputs
     (list go-github-com-golang-snappy
           go-gonum-org-v1-gonum))
    (home-page "https://github.com/kshedden/dstream")
    (synopsis "Process data streams in Golang")
    (description
     "Dstream is a package for manipulating streams of typed, multivariate
data in Go.  A Dstream is a dataframe-like container that holds a rectangular
array of data in which the columns are variables and the rows are cases or
observations.

Dstream is designed to handle large datasets, where it is not possible to load
all data for all variables into memory at once.  To achieve this, Dstream
utilizes a chunked, column-based storage format.  A chunk contains the data
for a contiguous block of rows.  The data are stored by variable (column-wise)
in typed Go slices.  Only one chunk of the Dstream is held in memory at one
time.")
    (license license:bsd-3)))

(define-public go-github-com-kshedden-statmodel
  (package
    (name "go-github-com-kshedden-statmodel")
    (version "0.0.0-20210519035403-ee97d3e48df1")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/kshedden/statmodel")
             (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0v1p0gzkjakci7wbp6x9b4zgnh1qs1lpr6dfb663w868q9hx95vy"))))
    (build-system go-build-system)
    (arguments
     (list
      #:skip-build? #t
      #:import-path "github.com/kshedden/statmodel"
      #:test-flags #~(list "-vet=off")
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'remove-examples-and-benchmarks
            (lambda* (#:key tests? import-path #:allow-other-keys)
              (with-directory-excursion (string-append "src/" import-path)
                (delete-file-recursively "duration/examples")
                (delete-file-recursively "glm/examples")))))))
    (propagated-inputs
     (list go-github-com-kshedden-dstream
           go-gonum-org-v1-gonum))
    (home-page "https://github.com/kshedden/statmodel")
    (synopsis "Statistical modeling in Golang")
    (description
     "This package implements a functionality for fitting statistical model.
Additional Go packages include @code{glm} for Generalized Liner Models and
@code{duration} for survival analysis.  All models can be fit with maximum (or
quasi-maximum) likelihood estimation, with optional L1 (Lasso) or L2 (ridge)
penalization.")
    (license license:bsd-3)))

(define-public go-github-com-montanaflynn-stats
  (package
    (name "go-github-com-montanaflynn-stats")
    (version "0.7.1")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/montanaflynn/stats")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0y38cvp7r6fb6291k82j781dbykx00mxw8ca0v9d0fijzc1x81fi"))))
    (build-system go-build-system)
    (arguments
     (list
      #:go go-1.23
      #:import-path "github.com/montanaflynn/stats"
      #:phases
      #~(modify-phases %standard-phases
          (add-after 'unpack 'remove-examples
            (lambda* (#:key tests? import-path #:allow-other-keys)
              (with-directory-excursion (string-append "src/" import-path)
                (delete-file-recursively "examples")))))))
    (home-page "https://github.com/montanaflynn/stats")
    (synopsis "Statistics library for Golang")
    (description
     "This package provides a statistical library for Golang.")
    (license license:expat)))

(define-public go-github-com-remyoudompheng-bigfft
  (package
    (name "go-github-com-remyoudompheng-bigfft")
    (version "0.0.0-20230129092748-24d4a6f8daec")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/remyoudompheng/bigfft")
             (commit (go-version->git-ref version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0qxfda0jq70ank99zlgfz7iig2jpicbbxnpr7xcf1v9p474ak2dx"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/remyoudompheng/bigfft"))
    (home-page "https://github.com/remyoudompheng/bigfft")
    (synopsis "Big integer multiplication library for using Fast Fourier transform")
    (description
     "Package bigfft implements multiplication of @code{big.Int} using
FFT (Schonhage-Strassen method for multiplying integers).")
    (license license:bsd-3)))

(define-public go-github-com-shopspring-decimal
  (package
    (name "go-github-com-shopspring-decimal")
    (version "1.4.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/shopspring/decimal")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1p1iz0ybsjvc8k3w6lf92drs51fgrcbz0ib1p4ihp3gmdq5rnzjk"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/shopspring/decimal"))
    (home-page "https://github.com/shopspring/decimal")
    (synopsis "Arbitrary-precision fixed-point decimal numbers in Golang")
    (description
     "Package decimal implements an arbitrary precision fixed-point decimal.
Features:
@itemize
@item the zero-value is 0, and is safe to use without initialization
@item addition, subtraction, multiplication with no loss of precision
@item division with specified precision
@item database/sql serialization/deserialization
@item JSON and XML serialization/deserialization
@end itemize")
    (license license:expat)))

(define-public go-github-com-x448-float16
  (package
    (name "go-github-com-x448-float16")
    (version "0.8.4")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/x448/float16")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0qg6ya30fra20hpa2qzqqzs8l95lvw9yzd87fdzq195xqi6crb2l"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/x448/float16"))
    (home-page "https://github.com/x448/float16")
    (synopsis "Float16 (Binary16) in Golang")
    (description
     "This package provides a
@url{https://en.wikipedia.org/wiki/Half-precision_floating-point_format,IEEE
754 half-precision floating-point format (binary16)} with IEEE 754 default
rounding for conversions.  IEEE 754-2008 refers to this 16-bit floating-point
format as binary16.")
    (license license:expat)))

(define-public go-gonum-org-v1-gonum
  (package
    (name "go-gonum-org-v1-gonum")
    (version "0.16.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/gonum/gonum")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "01mj449mlvp863d6k9zaz3y2z3vc0l5vcn046f17s83f49r0sh58"))))
    (build-system go-build-system)
    (arguments
     (list
      #:go go-1.23
      #:import-path "gonum.org/v1/gonum"
      #:test-subdirs
      #~(list "."
              "blas/..."
              "cmplxs/..."
              "diff/..."
              "dsp/fourier/..."
              "floats/..."
              "integrate/..."
              "internal/..."
              "interp/..."
              "lapack/..."
              "mat/..."
              "mathext/..."
              "num/..."
              "optimize/..."
              ;; Tests failing to compile on ARM systems with errors in
              ;; goroutines.
              #$@(if (target-x86-64?)
                     '("spatial/...")
                     '())
              "stat/..."
              "uniti/...")))
    (propagated-inputs
     (list go-github-com-goccmack-gocc
           go-github-com-google-go-cmp
           go-golang-org-x-exp
           go-golang-org-x-tools
           #;go-gonum-org-v1-plot ; not packed yet
           ))
    (home-page "https://www.gonum.org/")
    (synopsis "Set of numeric libraries for Golang")
    (description
     "Gonum is a set of packages designed to make writing numerical and
scientific algorithms productive, performant, and scalable.  It provides
libraries for matrices and linear algebra; statistics, probability
distributions, and sampling; tools for function differentiation,integration,
and optimization; network creation and analysis")
    (license license:expat)))

(define-public go-lukechampine-com-uint128
  (package
    (name "go-lukechampine-com-uint128")
    (version "1.3.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/lukechampine/uint128")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1yy6lbprrsl9gscxn4194kr5sfvgi9cgvjdxn2141k36ab3nz8ip"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "lukechampine.com/uint128"))
    (home-page "https://github.com/lukechampine/uint128")
    (synopsis "Uint128 for Golang")
    (description
     "This package provides a high-performance @code{Uint128} type that
supports standard arithmetic operations.  Unlike @code{math/big}, operations
on @code{Uint128} values always produce new values instead of modifying a
pointer receiver.  A @@code{Uint128} value is therefore immutable, just like
@code{uint64} and friends.")
    (license license:expat)))

(define-public go-modernc-org-mathutil
  (package
    (name "go-modernc-org-mathutil")
    (version "1.6.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://gitlab.com/cznic/mathutil")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0wafxarpfvys5p2wsamadkv8j54ahrv9dwmlba9xsxb85n4q9ywm"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "modernc.org/mathutil"))
    (propagated-inputs (list go-github-com-remyoudompheng-bigfft))
    (home-page "https://modernc.org/mathutil")
    (synopsis
     "Utilities supplemental to the Go standard @code{rand} and @code{math} packages")
    (description
     "Package mathutil provides utilities supplementing the standard
@code{math} and @code{math/rand} packages.")
    (license license:bsd-3)))

;;;
;;; Executables:
;;;

;;;
;;; Avoid adding new packages to the end of this file. To reduce the chances
;;; of a merge conflict, place them above in alphabetic order.
;;;