alifahrri / nmtools

A generic, composable multi-dimensional array library.

nmtools

A generic, composable multidimensional array library.

Requirement

• C++17 (full language features)

Supported compilers:

• gcc 9+
• clang 10+

Examples

• cmake examples
• notebook examples
• stm32 mbed examples
• arduino examples
• android examples

nmtools's Issues

add taylor series

cleanup ode implementation

• return value instead of taking reference
• constexpr support
• docs

add LU decomposition

add LU decompostion base and implemetation for eigen and armadillo backend

init benchmarks

• initial benchmarks using nanobench/google-benchmark

add fibonacci search for one dimensional optimization

section 4.3 in

Antoniou A, Lu WS. Practical optimization: algorithms and engineering applications. Springer Science & Business Media; 2007 Dec 14.

add blas module

• cleanup matvec, refactor to blas
• saxpy, gaxpy, dot, outer, in addition to mul and add
• constexpr support

add matrix transpose

cleanup interpolation module

• use linalg::tridiagonal for solving spline
• provide options to return callable instead of directly compute the results
• clean-up meta functions
• add linear splne

compiler error notes: Clang constexpr variable lifetime

clang error: note: read of variable whose lifetime has ended

branch: https://github.com/alifahrri/nmtools/tree/clang-compile-error-constexpr-variable-lifetime

CI log (clang-14)

2022-10-01T13:26:22.6894603Z In file included from /work/tests/meta/array/view/moveaxis.cpp:5:
2022-10-01T13:26:22.6895063Z In file included from /work/include/nmtools/array/view/moveaxis.hpp:4:
2022-10-01T13:26:22.6895649Z In file included from /work/include/nmtools/array/index/argsort.hpp:5:
2022-10-01T13:26:22.6919427Z /work/include/nmtools/array/shape.hpp:242:47: error: non-type template argument is not a constant expression
2022-10-01T13:26:22.6939473Z                     }, nmtools_tuple<meta::ct<(size_t)at(fixed_shape,0)>>{});
2022-10-01T13:26:22.6943928Z                                               ^~~~~~~~~~~~~~~~~~~~~~~~~
2022-10-01T13:26:22.6951885Z /work/include/nmtools/array/view/transpose.hpp:42:50: note: in instantiation of function template specialization 'nmtools::shape<true, nmtools::array::ndarray_t<std::array<float, 12>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 2>, nmtools::meta::integral_constant<unsigned long, 6>>>>' requested here
2022-10-01T13:26:22.6956189Z         using src_shape_type = decltype(nmtools::shape</*force_constant_index*/true>(meta::declval<array_t>()));
2022-10-01T13:26:22.6959811Z                                                  ^
2022-10-01T13:26:22.6966252Z /work/include/nmtools/array/view/decorator.hpp:129:26: note: in instantiation of template class 'nmtools::view::transpose_t<nmtools::array::ndarray_t<std::array<float, 12>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 2>, nmtools::meta::integral_constant<unsigned long, 6>>>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 0>, nmtools::meta::integral_constant<unsigned long, 2>>>' requested here
2022-10-01T13:26:22.6971507Z     struct decorator_t : view_t<Ts...>
2022-10-01T13:26:22.6971763Z                          ^
2022-10-01T13:26:22.6983224Z /work/include/nmtools/array/view/transpose.hpp:100:16: note: in instantiation of template class 'nmtools::view::decorator_t<nmtools::view::transpose_t, nmtools::array::ndarray_t<std::array<float, 12>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 2>, nmtools::meta::integral_constant<unsigned long, 6>>>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 0>, nmtools::meta::integral_constant<unsigned long, 2>>>' requested here
2022-10-01T13:26:22.6984659Z         return decorator_t<transpose_t,array_t,axes_t>{{array,axes}};
2022-10-01T13:26:22.6984952Z                ^
2022-10-01T13:26:22.6992103Z /work/include/nmtools/array/view/moveaxis.hpp:37:56: note: in instantiation of function template specialization 'nmtools::view::transpose<nmtools::array::ndarray_t<std::array<float, 12>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 2>, nmtools::meta::integral_constant<unsigned long, 6>>>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 0>, nmtools::meta::integral_constant<unsigned long, 2>>>' requested here
2022-10-01T13:26:22.6994480Z         using result_t = meta::remove_cvref_t<decltype(transpose(array,*order))>;
2022-10-01T13:26:22.6995209Z                                                        ^
2022-10-01T13:26:22.7005677Z /work/tests/meta/array/view/moveaxis.cpp:54:44: note: in instantiation of function template specialization 'nmtools::view::moveaxis<nmtools::array::ndarray_t<std::array<float, 12>, std::tuple<nmtools::meta::integral_constant<unsigned long, 1>, nmtools::meta::integral_constant<unsigned long, 2>, nmtools::meta::integral_constant<unsigned long, 6>>>, nmtools::meta::integral_constant<unsigned long, 0>, nmtools::meta::integral_constant<unsigned long, 1>>' requested here
2022-10-01T13:26:22.7006825Z         using view_type   = decltype(view::moveaxis(meta::declval<array_type>(),meta::declval<src_type>(),meta::declval<dst_type>()));
2022-10-01T13:26:22.7008561Z                                            ^
2022-10-01T13:26:22.7013855Z /work/include/nmtools/array/shape.hpp:242:55: note: read of variable whose lifetime has ended
2022-10-01T13:26:22.7015592Z                     }, nmtools_tuple<meta::ct<(size_t)at(fixed_shape,0)>>{});
2022-10-01T13:26:22.7017908Z                                                       ^

works fine on gcc

related code: https://github.com/alifahrri/nmtools/blob/clang-compile-error-constexpr-variable-lifetime/include/nmtools/array/shape.hpp#L236

                constexpr auto fixed_shape = meta::fixed_shape_v<array_t>;
                if constexpr (!meta::is_fail_v<decltype(fixed_shape)>) {
                    return meta::template_reduce<len(fixed_shape)-1>([&](auto init, auto index){
                        using init_type = decltype(init);
                        using type = meta::append_type_t<init_type,meta::ct<(size_t)at(fixed_shape,index+1)>>;
                        return type{};
                    }, nmtools_tuple<meta::ct<(size_t)at(fixed_shape,0)>>{});
                } else {
                    return impl::shape<array_t>(array);
                }

extend linalg for fixed and dynamic array impl

• extend and cleanup linalg module to support nmtools::array
• more benchmarks

python bindings

Add support for python

refactor backend directory structure and namespace

refactor backend directory structure to gla/backend and update namepace accordingly

update docker to include eigen & armadillo

add support to assign matrix from initializer list

add backtracking line search

references :
[1] https://people.maths.ox.ac.uk/hauser/hauser_lecture2.pdf
[2] https://en.wikipedia.org/wiki/Backtracking_line_search

add ode module

add fft

recursive fft

add linear regression

• least-squares fit of a straight line

add code coverage reporting

add codecov integration

add cubic interpolation for one dimensional interpolation

section 4.6 in

Antoniou A, Lu WS. Practical optimization: algorithms and engineering applications. Springer Science & Business Media; 2007 Dec 14.

clean-up cmake

• make installable
• easily find package
• reduce duplication using macro/function

matrix support

init matrix support (eigen & armadillo backend)

add inexact line search

drop fft

no longer support fft

cleanup curvefit

• make sinusoid to return value instead of taking reference
• add docs
• constexpr support

add decomposition and matrix inversion

• lu decomposition
• matrix inverse based on decomposition

Extend backtracking line search for multivariable

• multivariable support
• constexpr support

concepts and constraints

add fixed size matrix support

add inverse

add functional inverse frontend with eigen and armadillo backend

add gauss elimination

• forward elimination
• backward substitution
• naive gauss elimination
• gauss elimination with pivot & scales

make finite difference to return value instead of taking reference

from

template <size_t order, Formulas formula = Formulas::Centered, typename F, typename Scalar>
        void finite_difference(F &f, Scalar x, Scalar step, Scalar &d)
        {
            detail::finite_difference(detail::Order<order>{}, detail::ComputeType<formula>{}, f, x, step, d);
        }

to

template <size_t order, Formulas formula = Formulas::Centered, typename F, typename Scalar>
        auto finite_difference(F &f, Scalar x, Scalar step)
        {
            return detail::finite_difference(detail::Order<order>{}, detail::ComputeType<formula>{}, f, x, step);
        }

add matrix determinant

add elimination and decomposition for special matrices

• thomas algorithm for tridiagonal matrix elimination
• cholesky decomposition for symmetric matrix