@lakutata/math 0.0.0-stage → 3.1.3

package/vendor/symengine/AUTHORS

@@ -0,0 +1,101 @@
+All people who contributed to SymEngine by sending at least a patch or more (in
+the order of the date of their first contribution). You can generate this file
+by: bin/update_authors.sh
+
+
+Ondřej Čertík <ondrej@certik.us>
+Dale Lukas Peterson <hazelnusse@gmail.com>
+Thilina Bandara Rathnayake <thilinarmtb@gmail.com>
+Christopher Dembia <cld72@cornell.edu>
+Julien Rioux <julien.rioux@gmail.com>
+Sushant Hiray <hiraysushant@gmail.com>
+Thomas Hisch <t.hisch@gmail.com>
+Vinzent Steinberg <Vinzent.Steinberg@gmail.com>
+Isuru Fernando <isuruf@gmail.com>
+Peter Brady <petertbrady@gmail.com>
+Shivam Vats <shivamvats.iitkgp@gmail.com>
+Sumith Kulal <sumith1896@gmail.com>
+Sanka Rasnayaka <nuwan.ras@gmail.com>
+Abinash Meher <abinashdakshana999@gmail.com>
+Govind Sahai <gsiitbhu@gmail.com>
+AMiT Kumar <dtu.amit@gmail.com>
+Francesco Biscani <bluescarni@gmail.com>
+Connor Behan <connor.behan@gmail.com>
+Björn Dahlgren <bjodah@gmail.com>
+Ralf Stephan <ralf@ark.in-berlin.de>
+Indrek Mandre <indrek@mare.ee>
+Abhinav Agarwal <abhinavagarwal1996@gmail.com>
+Akash Trehan <akash.trehan123@gmail.com>
+Srajan Garg <srajan.garg@gmail.com>
+Abhimanyu Siwach <siwachabhi@gmail.com>
+Pradyot Prakash <pp2105@gmail.com>
+malayaleecoder <malayaleecoder@gmail.com>
+Nishant Nikhil <nishantiam@gmail.com>
+Zhang Yuning <codeworm96@outlook.com>
+Charles Chen <charlesyychen@gmail.com>
+Matthew Luszczak <myluszczak@ucdavis.edu>
+Iris Lui <irislui66@gmail.com>
+Rajith Vidanaarachchi <rajith.vidanaarachchi@gmail.com>
+Kunal Singh <kunalsingh.iitkgp@gmail.com>
+Vic Luo <vicluo96@gmail.com>
+James Stojic <jbrankos@yahoo.com>
+Arihant Parsoya <parsoyaarihant@gmail.com>
+Ritesh Kumar <babarwal.ritesh@gmail.com>
+Shikhar Jaiswal <jaiswalshikhar87@gmail.com>
+Vishu Sidana <vishusidana95@gmail.com>
+Siddharth Bhat <siddu.druid@gmail.com>
+Tao He <sighingnow@gmail.com>
+Chad Mills <chad.mills@gmail.com>
+Jean-Paul Pelteret <jppelteret@gmail.com>
+Ranjith Kumar <ranjith.dakshana2015@gmail.com>
+Kv Manohar <kvmanohar22@gmail.com>
+Kanchana Ruwanpathirana <kanchana.ruwanpathirana@gmail.com>
+Melanka Saroad <saroadmelanka@yahoo.com>
+Dirk Reusch <lists@kybdr.de>
+Gerrit Ansmann <wrzlrpmft@users.noreply.github.com>
+Jialin Ma <marlin-@gmx.cn>
+Nilay Pochhi <pochhi.nilay@gmail.com>
+Eeshan Gupta <eeshan9815@gmail.com>
+Ziyi Yan <cxfyzy@gmail.com>
+Andreas Humenberger <ahumenberger@gmail.com>
+Clouds Flowing <clouds.flowing@gmail.com>
+Sylvain Corlay <sylvain.corlay@gmail.com>
+Kieran Kaempen <kaempen2@illinois.edu>
+Alan Hu <alanlh2@illinois.edu>
+Rajiv Ranjan Singh <rajivperfect007@gmail.com>
+Francesco Bonazzi <franz.bonazzi@gmail.com>
+Simon Stelter <simon.stelter@gmail.com>
+Brandon Bocklund <brandonbocklund@gmail.com>
+Marcello Mansueto <mvm@mydatamodels.com>
+Steven Lee <stevenlee123@protonmail.com>
+Roger Luo <hiroger@qq.com>
+Jogi Miglani <jmig5776@gmail.com>
+Liam Keegan <liam@keegan.ch>
+Anubhav Gupta <anubhav.gupta.cse19@itbhu.ac.in>
+Rikard Nordgren <rikard.nordgren@farmaci.uu.se>
+Will Simmons <will.simmons@cambridgequantum.com>
+myd7349 <myd7349@gmail.com>
+Fabian Köhler <fabian.koehler@protonmail.ch>
+Naveen Sai <naveensaisreenivas@gmail.com>
+Rohit Goswami <rgoswami@ieee.org>
+Alec Edgington <alec.edgington@quantinuum.com>
+Peter Schmitteckert <peter.schmitteckert@quantumsimulations.de>
+Tom Barrett <tbb300@gmail.com>
+Pieter Eendebak <pieter.eendebak@gmail.com>
+Zgoda Iu.N <20000703@edu.spbgasu.ru>
+Sam James <sam@gentoo.org>
+Gabriel Baraldi <baraldigabriel@gmail.com>
+Christian Gould <christian.d.gould@gmail.com>
+Antonio Rojas <arojas@archlinux.org>
+Leander Schulten <Leander.Schulten@rwth-aachen.de>
+Anutosh Bhat <andersonbhat491@gmail.com>
+Christian Clauss <cclauss@me.com>
+Jason Siefken <siefkenj@gmail.com>
+Rubén Rincón Blanco <git@rinconblanco.es>
+Pavel Novichkov <9932831+PavelNovichkov@users.noreply.github.com>
+Einav Schwartz <einave156@gmail.com>
+Michał Górny <mgorny@gentoo.org>
+Julien Schueller <schueller@phimeca.com>
+Philipp Krones <philipp@recogni.com>
+Rujia Liu <rujialiu@user.noreply.github.com>
+Marco Caccin <160508713+mcaccin@users.noreply.github.com>

package/vendor/symengine/LICENSE

@@ -0,0 +1,254 @@
+Copyright (c) 2013-2017 SymEngine Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+-------------------------------------------------------------------------------
+
+All files in symengine/utilities/teuchos were taken from the Trilinos package
+and are licensed under the modified BSD license:
+
+                   Teuchos: Common Tools Package
+                Copyright (2004) Sandia Corporation
+
+Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
+license for use of this work by or on behalf of the U.S. Government.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the Corporation nor the names of the
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Questions? Contact Michael A. Heroux (maherou@sandia.gov)
+
+-------------------------------------------------------------------------------
+
+Code in symengine/sparse_matrix.cpp is a port from scipy sparse matrix module
+and licensed under the modified BSD license:
+
+Copyright (c) 2001, 2002 Enthought, Inc.
+All rights reserved.
+
+Copyright (c) 2003-2012 SciPy Developers.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  a. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+  b. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  c. Neither the name of Enthought nor the names of the SciPy Developers
+     may be used to endorse or promote products derived from this software
+     without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+Code in symengine/symengine_casts.h is licensed under the modified BSD license:
+
+Protocol Buffers - Google's data interchange format
+Copyright 2014 Google Inc.  All rights reserved.
+https://developers.google.com/protocol-buffers/
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---------------------------------------------------------------------------------
+Code in symengine/utilities/matchpycpp is licensed under this additional license:
+
+MIT License
+
+Copyright (c) 2016 Manuel Krebber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---------------------------------------------------------------------------------
+Code in symengine/parser/parser.tab.hh and symengine/parser/parser.tab.cc
+are licensed under the following modified GPL license. The special exception
+allows redistribution under the terms (BSD license) for SymEngine library.
+
+A Bison parser, made by GNU Bison 3.0.4.
+
+Bison interface for Yacc-like parsers in C
+
+Copyright (C) 1984, 1989-1990, 2000-2015 Free Software Foundation, Inc.
+
+This program 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.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+As a special exception, you may create a larger work that contains
+part or all of the Bison parser skeleton and distribute that work
+under terms of your choice, so long as that work isn't itself a
+parser generator using the skeleton or a modified version thereof
+as a parser skeleton.  Alternatively, if you modify or redistribute
+the parser skeleton itself, you may (at your option) remove this
+special exception, which will cause the skeleton and the resulting
+Bison output files to be licensed under the GNU General Public
+License without this special exception.
+
+This special exception was added by the Free Software Foundation in
+version 2.2 of Bison.
+
+C LALR(1) parser skeleton written by Richard Stallman, by
+simplifying the original so-called "semantic" parser.
+
+---------------------------------------------------------------------------------
+
+All files in symengine/utilities/cereal were taken from the Cereal package
+and are licensed under the BSD-3-Clause license:
+
+Copyright (c) 2014, Randolph Voorhies, Shane Grant
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of cereal nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL RANDOLPH VOORHIES OR SHANE GRANT BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+All files in symengine/utilities/fast_float were taken from the fastfloat library
+and are licensed under the MIT License:
+
+Copyright (c) 2021 The fast_float authors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/vendor/symengine/README.md

@@ -0,0 +1,199 @@
+# SymEngine
+
+[![Build and test symengine](https://github.com/symengine/symengine/actions/workflows/ci.yml/badge.svg)](https://github.com/symengine/symengine/actions/workflows/ci.yml)
+[![codecov.io](https://codecov.io/github/symengine/symengine/coverage.svg?branch=master)](https://codecov.io/github/symengine/symengine?branch=master)
+
+SymEngine is a standalone fast C++ symbolic manipulation library. Optional thin
+wrappers allow usage of the library from other languages, e.g.:
+
+* C wrappers allow usage from C, or as a basis for other wrappers (the [symengine/cwrapper.h](https://github.com/sympy/symengine/tree/master/symengine/cwrapper.h) file)
+* Python wrappers allow easy usage from Python and integration with [SymPy](http://sympy.org/) and [Sage](http://www.sagemath.org/) (the [symengine.py](https://github.com/symengine/symengine.py) repository)
+* Ruby wrappers (the [symengine.rb](https://github.com/symengine/symengine.rb) repository)
+* Julia wrappers (the [SymEngine.jl](https://github.com/symengine/SymEngine.jl) repository)
+* Haskell wrappers (the [symengine.hs](https://github.com/symengine/symengine.hs) repository)
+* ...
+
+## Try SymEngine
+
+Tutorials are at [SymEngine.org](https://symengine.org/design/design.html).
+
+Run an interactive C++ session with SymEngine using [![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/symengine/symengine/master?filepath=docs/mystMD/firststeps.myst.md).
+
+## License
+
+All files are licensed under MIT license, see the [LICENSE](LICENSE) for more
+information. Third party code packaged are licensed under BSD 3-clause license
+(see the LICENSE file).
+
+## Mailinglist, Chat
+
+SymEngine mailinglist: http://groups.google.com/group/symengine
+
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/symengine/symengine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Installation
+
+### Conda package manager
+
+    conda install symengine -c conda-forge
+
+### Conan package manager
+
+    conan install --requires="symengine/[*]"
+
+### Building from source
+
+Install prerequisites.
+For Debian based systems (Ubuntu etc.):
+
+    apt-get install cmake libgmp-dev
+
+For RPM based systems (Fedora etc.):
+
+    yum install cmake gmp-devel
+
+Install SymEngine:
+
+    mkdir build && cd build
+    cmake ..
+    make
+    make install
+
+This will configure and build SymEngine in the default Release mode with all
+code and compiler optimizations on and then install it on your system.
+
+Run tests:
+
+    ctest
+
+### Development
+
+[GitHub Actions checks](https://github.com/symengine/symengine/actions/workflows/ci.yml)
+the code in both Release and Debug mode with all possible checks, so just
+sending a GitHub pull request is enough and you can use any mode you want to
+develop it. However, the best way to develop SymEngine on Linux is to use the
+Debug mode with `BFD` support on:
+
+    cmake -DCMAKE_BUILD_TYPE=Debug -DWITH_BFD=yes ..
+
+This `BFD` support turns on nice Python-like stack traces on exceptions, assert
+errors or segfaults, and the Debug mode automatically turns on
+`WITH_SYMENGINE_RCP=no` (which uses `Teuchos::RCP` with full Debug time
+checking) and `WITH_SYMENGINE_ASSERT=yes`, so the code cannot segfault in Debug
+mode, as long as our style conventions (e.g. no raw pointers) are followed,
+which is easy to check by visual inspection of a given Pull Request. In Release
+mode, which is the default, the code is as performing a manual reference
+counting and raw pointers (and if there is a bug, it could segfault, in which
+case all you have to do is to turn Debug mode on and get a nice exception with
+a stack trace).
+
+To make `WITH_BFD=yes` work, you need to install `binutils-dev` first,
+otherwise, you will get a `CMake` error during configuring.
+For Debian-based systems (Ubuntu etc.)
+
+    apt-get install binutils-dev
+
+For RPM-based systems (Fedora etc.)
+
+    yum install binutils-devel
+
+On OpenSuSE, you will additionally need `glibc-devel`.
+
+## CMake Options
+
+Here are all the `CMake` options that you can use to configure the build, with
+their default values are indicated below:
+
+    cmake -DCMAKE_INSTALL_PREFIX:PATH="/usr/local" \  # Installation prefix
+        -DCMAKE_BUILD_TYPE:STRING="Release" \         # Type of build, one of: Debug, Release, RelWithDebInfo, MinSizeRel
+        -DWITH_BFD:BOOL=OFF \                         # Install with BFD library (requires binutils-dev)s
+        -DWITH_SYMENGINE_ASSERT:BOOL=OFF \            # Test all SYMENGINE_ASSERT statements in the code
+        -DWITH_SYMENGINE_RCP:BOOL=ON \                # Use our faster special implementation of RCP
+        -DWITH_SYMENGINE_THREAD_SAFE:BOOL=OFF \       # Build with thread safety
+        -DWITH_ECM:BOOL=OFF \                         # Build with GMP-ECM library for integer factorization
+        -DWITH_PRIMESIEVE:BOOL=OFF \                  # Install with Primesieve library
+        -DWITH_FLINT:BOOL=OFF \                       # Install with Flint library
+        -DWITH_ARB:BOOL=OFF \                         # Install with ARB library
+        -DWITH_TCMALLOC:BOOL=OFF \                    # Install with TCMalloc linked
+        -DWITH_OPENMP:BOOL=OFF \                      # Install with OpenMP enabled
+        -DWITH_PIRANHA:BOOL=OFF \                     # Install with Piranha library
+        -DWITH_MPFR:BOOL=OFF \                        # Install with MPFR library
+        -DWITH_MPC:BOOL=OFF \                         # Install with MPC library
+        -DWITH_LLVM:BOOL=OFF \                        # Build with LLVM libraries
+        -DWITH_SYSTEM_CEREAL:BOOL=OFF \               # Build with cereal headers from the system instead of
+                                                        the vendored copy
+        -DBUILD_TESTS:BOOL=ON \                       # Build with tests
+        -DBUILD_CUDA_TESTS:BOOL=OFF \                 # Build with cuda tests (requires cuda and an nvidia GPU)
+        -DBUILD_METAL_TESTS:BOOL=OFF \                # Build with metal tests (requires macOS, Metal, and metal-cpp headers)
+        -DBUILD_BENCHMARKS:BOOL=ON \                  # Build with benchmarks
+        -DBUILD_BENCHMARKS_GOOGLE:BOOL=OFF \          # Build with Google Benchmark benchmarks
+        -DINTEGER_CLASS:STRING=gmp \                  # Choose storage type for Integer. one of gmp, gmpxx,
+                                                        flint, piranha, boostmp
+        -DBUILD_SHARED_LIBS:BOOL=OFF \                # Build a shared library.
+        -DCMAKE_INSTALL_RPATH_USE_LINK_PATH:BOOL=OFF\ # Add dependencies to rpath when a shared lib is built
+        ..
+
+If `OpenMP` is enabled, then `SYMENGINE_THREAD_SAFE` is also enabled automatically
+irrespective of the user input for `WITH_SYMENGINE_THREAD_SAFE`.
+
+`CMake` prints the value of its options at the end of the run.
+If you want to use a different compiler, do:
+
+    CC=clang CXX=clang++ cmake ..
+
+If you want to set additional compilation flags, do:
+
+    CXXFLAGS="$CXXFLAGS -march=native" cmake ..
+
+These environment variables are checked only in the first run of
+cmake and you have to delete the build directory or `CMakeCache.txt` file
+for these environment variables to be picked up in subsequent runs.
+
+Using `INTEGER_CLASS=boostmp` would remove the dependency on gmp and use boost's
+multiprecision integer and rational classes. This would make boost, the only
+dependency and all the code would be under permissive licenses, namely, MIT,
+BSD 3-clause and Boost License.
+
+Piranha (`WITH_PIRANHA`) depends on Boost, so it is off by default. The benchmarked
+code seems to depend on the order in which you
+execute the benchmarks in a given executable, due to internal malloc
+implementation. We have found that this order dependence is reduced by enabling
+`WITH_TCMALLOC=ON` and since it also speeds the benchmarks up, we recommend
+to always use TCMalloc when benchmarking (and the `Release` mode of SymEngine,
+which is the default).
+
+### External Libraries
+
+Use `CMAKE_PREFIX_PATH` to specify the prefixes of the external libraries.
+
+    cmake -DCMAKE_PREFIX_PATH=<prefix1>;<prefix2>
+
+If the headers and libs are not in `<prefix>/include` and `<prefix>/lib` respectively,
+use `CMAKE_LIBRARY_PATH` and `CMAKE_INCLUDE_PATH`.
+
+If CMake still cannot find the library, you can specify the path to the library by
+doing `cmake -DPKG_LIBRARY=/path/libname.so .`, where `PKG` should be replaced
+with the name of the external library (`GMP`, `ARB`, `BFD`, `FLINT`, `MPFR`, ...).
+Similarly, `-DPKG_INCLUDE_DIR` can be used for headers.
+
+### Recommended options to build
+
+#### For package managers
+
+For packaging symengine it is recommended to use `GMP, MPFR, MPC, FLINT, LLVM` as
+dependencies if they are available and built with thread safety on.
+
+    cmake -DWITH_MPFR=on -DWITH_MPC=on -DINTEGER_CLASS=flint -DWITH_LLVM=on
+    -DWITH_SYMENGINE_THREAD_SAFE=on ..
+
+#### Optimized build
+
+To build with more optimizations, you can use the above dependencies and options, and also,
+
+    CXXFLAGS="-march=native -O3" cmake -DWITH_TCMALLOC=on -DWITH_SYMENGINE_THREAD_SAFE=no ..
+
+## Developer Documentation
+
+Please follow the [C++ Style Guide](docs/Doxygen/md/style_guide.md) when developing.
+
+The design decisions are documented in [Design](https://symengine.org/design/design.html).