subsample.hpp

Go to the documentation of this file.

#ifndef GENESIS_POPULATION_FUNCTION_SUBSAMPLE_H_
#define GENESIS_POPULATION_FUNCTION_SUBSAMPLE_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2024 Lucas Czech
 
    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@sund.ku.dk>
    University of Copenhagen, Globe Institute, Section for GeoGenetics
    Oster Voldgade 5-7, 1350 Copenhagen K, Denmark
*/
 
#include "genesis/population/sample_counts.hpp"
#include "genesis/population/variant.hpp"
 
namespace genesis {
namespace population {
 
// =================================================================================================
//     Subscaling and rescaling
// =================================================================================================
 
void subscale_counts(
    SampleCounts& sample,
    size_t max_depth
);
 
void subscale_counts(
    Variant& variant,
    size_t max_depth
);
 
void rescale_counts(
    SampleCounts& sample,
    size_t target_depth
);
 
void rescale_counts(
    Variant& variant,
    size_t target_depth
);
 
// =================================================================================================
//     Subsampling and resampling with replacement
// =================================================================================================
 
void subsample_counts_with_replacement(
    SampleCounts& sample,
    size_t max_depth
);
 
void subsample_counts_with_replacement(
    Variant& variant,
    size_t max_depth
);
 
void resample_counts(
    SampleCounts& sample,
    size_t target_depth
);
 
void resample_counts(
    Variant& variant,
    size_t target_depth
);
 
// =================================================================================================
//     Subsampling without replacement
// =================================================================================================
 
void subsample_counts_without_replacement(
    SampleCounts& sample,
    size_t max_depth
);
 
void subsample_counts_without_replacement(
    Variant& variant,
    size_t max_depth
);
 
} // namespace population
} // namespace genesis
 
#endif // include guard