Annealing is a C11 language extension library for GSL, the GNU Scientific Library, attempting a redesign of the simulated annealing module.
The library targets POSIX systems. The last time the author bothered to update this paragraph he had tested GSL 2.5.
The package uses the GNU Autotools and it is tested, using Travis CI, on
both Ubuntu GNU+Linux systems and OS X systems. The package relies on
pkg-config to find the dependencies installed on the system.
Copyright (c) 2007, 2009, 2014, 2019 Marco Maggi
marco.maggi-ipsu@poste.it
Copyright (C) 1996, 1997, 1998, 1999, 2000 Mark Galassi
All rights reserved.
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/.
To install from a proper release tarball, do this:
$ cd annealing-0.1.0
$ mkdir build
$ cd build
$ ../configure
$ make
$ make check
$ make install
to inspect the available configuration options:
$ ../configure --help
The Makefile is designed to allow parallel builds, so we can do:
$ make -j4 all && make -j4 check
which, on a 4-core CPU, should speed up building and checking significantly.
The Makefile supports the DESTDIR environment variable to install files in a temporary location, example: to see what will happen:
$ make -n install DESTDIR=/tmp/annealing
to really do it:
$ make install DESTDIR=/tmp/annealing
After the installation it is possible to verify the installed library against the test suite with:
$ make installcheck
From a repository checkout or snapshot (the ones from the Github site):
we must install the GNU Autotools (GNU Automake, GNU Autoconf, GNU
Libtool), then we must first run the script autogen.sh from the top
source directory, to generate the needed files:
$ cd annealing
$ sh autogen.sh
notice that autogen.sh will run the programs autoreconf and
libtoolize; the latter is selected through the environment variable
LIBTOOLIZE, whose value can be customised; for example to run
glibtoolize rather than libtoolize we do:
$ LIBTOOLIZE=glibtoolize sh autogen.sh
After this the procedure is the same as the one for building from a proper release tarball, but we have to enable maintainer mode:
$ ../configure --enable-maintainer-mode [options]
$ make
$ make check
$ make install
Read the documentation generated from the Texinfo sources. The package installs the documentation in Info format; we can generate and install documentation in HTML format by running:
$ make html
$ make install-html
Annealing was written by Marco Maggi reworking code by Mark Galassi distributed in the GSL.
The code is a reworking of the files gsl_siman.h and siman.c from
the GSL 1.9 distribution (Thu Feb 22, 2007). The TSP test is a
reworking of siman_tsp.c. The documentation is a reworking of the
"Simulated Annealing" node in the GSL's Texinfo source.
Bug and vulnerability reports are appreciated, all the vulnerability reports are public; register them using the Issue Tracker at the project's GitHub site. For contributions and patches please use the Pull Requests feature at the project's GitHub site.
The latest release of this package can be downloaded from:
https://bitbucket.org/marcomaggi/annealing/downloads
development takes place at:
http://github.com/marcomaggi/annealing/
and as backup at:
https://bitbucket.org/marcomaggi/annealing/
the documentation is available online:
http://marcomaggi.github.io/docs/annealing.html
the GNU Project software can be found here:
the latest revision of the GNU Scientific Library can be found here:
http://www.gnu.org/software/gsl/
Travis CI is a hosted, distributed continuous integration service used to build and test software projects hosted at GitHub. We can find this project's dashboard at:
https://travis-ci.org/marcomaggi/annealing
Usage of this service is configured through the file .travis.yml and
additional scripts are under the directory meta/travis-ci.
The Clang Static Analyzer is a source code analysis tool that finds bugs in C, C++, and Objective-C programs. It is distributed along with Clang and we can find it at:
http://clang-analyzer.llvm.org/
Usage of this service is implemented with make rules; see the relevant
section in the file Makefile.am.
Codecov is a service providing code coverage reports. We can find this project's dashboard at:
https://codecov.io/gh/marcomaggi/annealing
Usage of this service is implemented through direct interface between
GitHub and Codecov sites; it configured through the file codecov.yml
and appropriate entries in Travis CI's matrix of builds.
Codacy is an online service providing code review. We can find this project's dashboard at:
https://www.codacy.com/app/marcomaggi/annealing
Usage of this service is implemented through direct integration between GitHub and Codacy sites.