cog.hpp

Go to the documentation of this file.

#ifndef GENESIS_PLACEMENT_FUNCTION_COG_H_
#define GENESIS_PLACEMENT_FUNCTION_COG_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/placement/placement_tree.hpp"

namespace genesis {
namespace placement {

// =================================================================================================
//     Forward Declarations
// =================================================================================================

class Sample;

// =================================================================================================
//     Center of Gravity
// =================================================================================================

std::pair<PlacementTreeEdge const*, double> center_of_gravity (
    Sample const& smp,
    bool const    with_pendant_length = false
);

double center_of_gravity_variance (
    Sample const& smp,
    bool const    with_pendant_length = false
);

double center_of_gravity_distance (
    Sample const& smp_a,
    Sample const& smp_b,
    bool const    with_pendant_length = false
);

} // namespace placement
} // namespace genesis

#endif // include guard