package.yaml

name:                numeric-optimization
version:             0.2.0.0
github:              "msakai/nonlinear-optimization-ad"
license:             BSD3
author:              "Masahiro Sakai"
maintainer:          "masahiro.sakai@gmail.com"
copyright:           "Copyright (c) 2023 Masahiro Sakai"

extra-source-files:
- README.md
- CHANGELOG.md

# Metadata used when publishing your package
synopsis:            Unified interface to various numerical optimization algorithms
category:            Math, Algorithms, Optimisation, Optimization, Numeric, Numerical

# To avoid duplicated efforts in documentation and dealing with the
# complications of embedding Haddock markup inside cabal files, it is
# common to point users to the README.md file.
description:         Please see the README on GitHub at <https://github.com/msakai/nonlinear-optimization-ad/tree/master/numeric-optimization#readme>

tested-with:
- GHC == 9.8.2
- GHC == 9.6.5
- GHC == 9.4.5
- GHC == 9.2.8
- GHC == 9.0.2
- GHC == 8.10.7
- GHC == 8.8.4
- GHC == 8.6.5

flags:
  with-cg-descent:
    description: Enable CGDescent optimization algorithm provided by nonlinear-optimization package and CG_DESCENT-C library. Since they are licensed under GPL, setting this flag True implies that resulting binary is also under GPL.
    default: false
    manual: true

  with-lbfgs:
    description: Enable L-BFGS (since 0.1.1.0)
    default: true
    manual: true

  with-lbfgsb:
    description: Enable L-BFGS-B (since 0.1.1.0)
    default: false
    manual: true

  build-examples:
    description: Build example programs
    default: false
    manual: true

dependencies:
- base >=4.12 && <5
- data-default-class >=0.1.2.0 && <0.3
- vector >=0.12.0.2 && <0.14

ghc-options:
- -Wall
- -Wcompat
- -Widentities
- -Wincomplete-record-updates
- -Wincomplete-uni-patterns
- -Wmissing-export-lists
- -Wmissing-home-modules
- -Wpartial-fields
- -Wredundant-constraints

library:
  source-dirs: src
  other-modules:
  - Numeric.Optimization.Internal.Base
  - Numeric.Optimization.Internal.Method.CGDescent
  - Numeric.Optimization.Internal.Method.LBFGS
  - Numeric.Optimization.Internal.Method.LBFGSB
  - Numeric.Optimization.Internal.Method.Newton
  dependencies:
  - constraints
  - containers >=0.6.0.1 && <0.8
  - hmatrix >=0.20.0.0
  - numeric-limits >=0.1 && <0.2
  - mono-traversable >=1.0.15.1 && <1.1
  - mtl >=2.2.2 && <2.4
  - primitive >=0.6.4.0
  when:   
    - condition: flag(with-cg-descent)
      then:
        dependencies:
        - nonlinear-optimization >=0.3.7 && <0.4
        cpp-options: "-DWITH_CG_DESCENT"
      else:
        # dummy for avoiding "'else' branch of 'if' is empty" error on old Cabal
        cpp-options: " "
    - condition: flag(with-lbfgs)
      then:
        dependencies:
        - lbfgs >=0.1 && <0.2
        cpp-options: "-DWITH_LBFGS"
      else:
        # dummy for avoiding "'else' branch of 'if' is empty" error on old Cabal
        cpp-options: " "
    - condition: flag(with-lbfgsb)
      then:
        dependencies:
        - l-bfgs-b >=0.1.0.1 && <0.2
        cpp-options: "-DWITH_LBFGSB"
      else:
        # dummy for avoiding "'else' branch of 'if' is empty" error on old Cabal
        cpp-options: " "

executables:
  rosenbrock:
    main:                rosenbrock.hs
    source-dirs:         examples
    ghc-options:
    - -threaded
    - -rtsopts
    - -with-rtsopts=-N
    dependencies:
    - numeric-optimization
    when:
    - condition: flag(build-examples)
      then:
        buildable: true
      else:
        buildable: false

tests:
  numeric-optimization-test:
    main:                Spec.hs
    source-dirs:         test
    ghc-options:
    - -threaded
    - -rtsopts
    - -with-rtsopts=-N
    dependencies:
    - containers >=0.6.0.1 && <0.8
    - hmatrix
    - hspec >=2.7.1 && <3.0
    - HUnit >=1.6.0.0 && <1.7
    - numeric-optimization