tickmarks.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_TOOLS_TICKMARKS_H_
#define GENESIS_UTILS_TOOLS_TICKMARKS_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 <cstddef>
#include <limits>
#include <vector>

namespace genesis {
namespace utils {

// =================================================================================================
//     Tickmarks
// =================================================================================================

struct Tickmarks
{
public:

    // -------------------------------------------------------------------------
    //     Helper Structs
    // -------------------------------------------------------------------------

    struct LabeledTick
    {
        LabeledTick( double rel_pos, double lab )
            : relative_position( rel_pos )
            , label( lab )
        {}

        double relative_position;
        double label;
    };

    // -------------------------------------------------------------------------
    //     Constructors and Rule of Five
    // -------------------------------------------------------------------------

    Tickmarks() = default;
    ~Tickmarks() = default;

    Tickmarks(Tickmarks const&) = default;
    Tickmarks(Tickmarks&&)      = default;

    Tickmarks& operator= (Tickmarks const&) = default;
    Tickmarks& operator= (Tickmarks&&)      = default;

    // -------------------------------------------------------------------------
    //     Drudges
    // -------------------------------------------------------------------------

    static double step_size( double interval_size, size_t target_steps );

    std::vector<double> linear_ticks( double min, double max, size_t target_steps );

    std::vector<LabeledTick> linear_labels( double min, double max, size_t target_steps );

    std::vector<LabeledTick> logarithmic_labels( double min, double max, double base = 10.0 );

    // -------------------------------------------------------------------------
    //     Data Members
    // -------------------------------------------------------------------------

public:

    bool include_min = true;

    bool include_max = true;

    bool undershoot_at_min = false;

    bool overshoot_at_max = false;

    double relative_epsilon = std::numeric_limits<double>::epsilon();

};

} // namespace utils
} // namespace genesis

#endif // include guard