linalg.h

Go to the documentation of this file.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (w) 2014 Soumyajit De
 * Written (w) 2014 Khaled Nasr
 * All rights reserved.
 *
 * 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.
 *
 * 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.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 */

#ifndef LINALG_H_
#define LINALG_H_

#include <shogun/lib/config.h>

#if defined(HAVE_CXX0X) || defined(HAVE_CXX11)
namespace shogun
{

namespace linalg
{

enum class Backend
{
    EIGEN3,
#ifdef HAVE_VIENNACL
    VIENNACL,
#endif
    NATIVE,
    DEFAULT = 0
};

template <class Module>
struct linalg_traits : Module
{
};

#ifndef DOXYGEN_SHOULD_SKIP_THIS

#ifndef SET_MODULE_BACKEND
#define SET_MODULE_BACKEND(MODULE, BACKEND) \
struct MODULE \
{ \
    const static Backend backend = Backend::BACKEND; \
};
#endif // SET_MODULE_BACKEND

#ifndef SET_GLOBAL_BACKEND
#define SET_GLOBAL_BACKEND(BACKEND) \
    SET_MODULE_BACKEND(Core, BACKEND) \
    SET_MODULE_BACKEND(Redux, BACKEND) \
    SET_MODULE_BACKEND(Linsolver, BACKEND) \
    SET_MODULE_BACKEND(Eigsolver, BACKEND)
#endif // SET_GLOBAL_BACKEND

#ifdef USE_EIGEN3
    SET_GLOBAL_BACKEND(EIGEN3)
#elif USE_VIENNACL
    SET_GLOBAL_BACKEND(VIENNACL)
#else

#ifdef USE_EIGEN3_CORE
    SET_MODULE_BACKEND(Core, EIGEN3)
#elif USE_VIENNACL_CORE
    SET_MODULE_BACKEND(Core, VIENNACL)
#else // the default case
    SET_MODULE_BACKEND(Core, DEFAULT)
#endif

#ifdef USE_EIGEN3_REDUX
    SET_MODULE_BACKEND(Redux, EIGEN3)
#elif USE_VIENNACL_REDUX
    SET_MODULE_BACKEND(Redux, VIENNACL)
#else // the default case
    SET_MODULE_BACKEND(Redux, DEFAULT)
#endif

#ifdef USE_EIGEN3_LINSLV
    SET_MODULE_BACKEND(Linsolver, EIGEN3)
#elif USE_VIENNACL_LINSLV
    SET_MODULE_BACKEND(Linsolver, VIENNACL)
#else // the default case
    SET_MODULE_BACKEND(Linsolver, DEFAULT)
#endif

#ifdef USE_EIGEN3_EIGSLV
    SET_MODULE_BACKEND(Eigsolver, EIGEN3)
#elif USE_VIENNACL_EIGSLV
    SET_MODULE_BACKEND(Eigsolver, VIENNACL)
#else // the default case
    SET_MODULE_BACKEND(Eigsolver, DEFAULT)
#endif

#endif // end of global settings

#undef SET_GLOBAL_BACKEND
#undef SET_MODULE_BACKEND

#endif // DOXYGEN_SHOULD_SKIP_THIS
}

}

#include <shogun/mathematics/linalg/internal/modules/Core.h>
#include <shogun/mathematics/linalg/internal/modules/Util.h>

#include <shogun/mathematics/linalg/internal/modules/Redux.h>
#include <shogun/mathematics/linalg/internal/modules/SpecialPurpose.h>

#include <shogun/mathematics/linalg/internal/modules/ElementwiseOperations.h>

#endif // defined(HAVE_CXX0X) || defined(HAVE_CXX11)
#endif // LINALG_H_