mds.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_MATH_MDS_H_
#define GENESIS_UTILS_MATH_MDS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2018 Lucas Czech and HITS gGmbH
 
    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/>.
 
    Contact:
    Lucas Czech <lucas.czech@h-its.org>
    Exelixis Lab, Heidelberg Institute for Theoretical Studies
    Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
*/
 
#include "genesis/utils/containers/matrix.hpp"
 
#include <vector>
 
namespace genesis {
namespace utils {
 
// ================================================================================================
//     Settings for Functions
// ================================================================================================
 
enum class MdsAlgorithm
{
    kUcf,
 
    kSmacof
};
 
// ================================================================================================
//     Multi-Dimensional Scaling
// ================================================================================================
 
Matrix<double> multi_dimensional_scaling(
    Matrix<double> const& distances,
    size_t                dimensions = 2,
    size_t                iterations = 100,
    MdsAlgorithm          algorithm = MdsAlgorithm::kUcf
);
 
Matrix<double> multi_dimensional_scaling(
    Matrix<double> const& distances,
    Matrix<double> const& initial_values,
    size_t                dimensions = 2,
    size_t                iterations = 100,
    MdsAlgorithm          algorithm = MdsAlgorithm::kUcf
);
 
} // namespace utils
} // namespace genesis
 
#endif // include guard