## File: defs.hh

package info (click to toggle)
bliss 0.73-5
 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115 #ifndef BLISS_DEFS_HH #define BLISS_DEFS_HH #include #include /* Copyright (c) 2003-2015 Tommi Junttila Released under the GNU Lesser General Public License version 3. This file is part of bliss. bliss is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 3 of the License. bliss 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with bliss. If not, see . */ namespace bliss { /** * The version number of bliss. */ static const char * const version = "0.73"; /* * If a fatal error (out of memory, internal error) is encountered, * this function is called. * There should not be a return from this function but exit or * a jump to code that deallocates the AbstractGraph instance that called this. */ void fatal_error(const char* fmt, ...); #if defined(BLISS_DEBUG) #define BLISS_CONSISTENCY_CHECKS #define BLISS_EXPENSIVE_CONSISTENCY_CHECKS #endif #if defined(BLISS_CONSISTENCY_CHECKS) /* Force a check that the found automorphisms are valid */ #define BLISS_VERIFY_AUTOMORPHISMS #endif #if defined(BLISS_CONSISTENCY_CHECKS) /* Force a check that the generated partitions are equitable */ #define BLISS_VERIFY_EQUITABLEDNESS #endif } // namespace bliss /*! \mainpage Bliss * * \section intro_sec Introduction * * This is the source code documentation of bliss, * produced by running doxygen in * the source directory. * The algorithms and data structures used in bliss are documented in * the papers found at the * bliss web site. * * * \section compile_sec Compiling * * Compiling bliss in Linux should be easy, just execute * \code * make * \endcode * in the bliss source directory. * This will produce the executable program \c bliss as well as * the library file \c libbliss.a that can be linked in other programs. * If you have the GNU Multiple Precision * Arithmetic Library (GMP) installed in your machine, you can also use * \code * make gmp * \endcode * to enable exact computation of automorphism group sizes. * * When linking the bliss library \c libbliss.a in other programs, * remember to include the standard c++ library * (and the GMP library if you compiled bliss to include it). * For instance, * \code gcc -o test test.c -lstdc++ -lgmp -lbliss\endcode * * \section cppapi_sec The C++ language API * * The C++ language API is the main API to bliss; * all other APIs are just more or less complete variants of it. * The C++ API consists basically of the public methods in * the classes bliss::AbstractGraph, bliss::Graph, and bliss::Digraph. * For an example of its use, * see the \ref executable "source of the bliss executable". * * * \section capi_sec The C language API * * The C language API is given in the file bliss_C.h. * It is currently more restricted than the C++ API so * consider using the C++ API whenever possible. */ #endif