utils/math/bitvector/operators.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_MATH_BITVECTOR_OPERATORS_H_
#define GENESIS_UTILS_MATH_BITVECTOR_OPERATORS_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2022 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 <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/math/bitvector.hpp"
 
#include <iosfwd>
 
namespace genesis {
namespace utils {
 
// =================================================================================================
//     Bitvector Operators
// =================================================================================================
 
Bitvector bitwise_and( Bitvector const& lhs, Bitvector const& rhs, bool use_larger = false );
 
Bitvector bitwise_or( Bitvector const& lhs, Bitvector const& rhs, bool use_larger = false );
 
Bitvector bitwise_xor( Bitvector const& lhs, Bitvector const& rhs, bool use_larger = false );
 
Bitvector set_minus (Bitvector const& lhs, Bitvector const& rhs);
Bitvector symmetric_difference( Bitvector const& lhs, Bitvector const& rhs );
 
bool is_strict_subset( Bitvector const& sub, Bitvector const& super );
 
bool is_strict_superset( Bitvector const& super, Bitvector const& sub );
 
bool is_subset( Bitvector const& sub, Bitvector const& super );
 
bool is_superset( Bitvector const& super, Bitvector const& sub );
 
// /* *
//  * @brief Return whether @p lhs is lexicographically less than @p rhs.
//  *
//  * This function consideres the bits ordered with most significant bits towards the left, so that
//  * `0001 < 1000` for example. Both Bitvector%s have to have the same length (this could be
//  * implemented for Bitvectors of different size, but that is not needed as of now, so it isn't).
//  */
// bool is_lexicographically_less( Bitvector const& lhs, Bitvector const& rhs );
//
// /* *
//  * @brief Return whether @p lhs is lexicographically less than @p rhs, or equal to it.
//  *
//  * @copydetails is_lexicographically_less()
//  */
// bool is_lexicographically_less_or_equal( Bitvector const& lhs, Bitvector const& rhs );
//
// /* *
//  * @brief Return whether @p lhs is lexicographically greater than @p rhs.
//  *
//  * @copydetails is_lexicographically_less()
//  */
// bool is_lexicographically_greater( Bitvector const& lhs, Bitvector const& rhs );
//
// /* *
//  * @brief Return whether @p lhs is lexicographically greater than @p rhs, or equal to it.
//  *
//  * @copydetails is_lexicographically_less()
//  */
// bool is_lexicographically_greater_or_equal( Bitvector const& lhs, Bitvector const& rhs );
 
std::ostream& operator << ( std::ostream& out, Bitvector const& bv );
 
std::istream& operator >> ( std::istream& in, Bitvector& bv );
 
} // namespace utils
} // namespace genesis
 
#endif // include guard