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-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/math/bitvector.hpp"

#include <iosfwd>

namespace genesis {
namespace utils {

// =================================================================================================
//     Bitvector Operators
// =================================================================================================

Bitvector operator & (Bitvector const& lhs, Bitvector const& rhs);
Bitvector operator | (Bitvector const& lhs, Bitvector const& rhs);
Bitvector operator ^ (Bitvector const& lhs, Bitvector const& rhs);

Bitvector bitwise_and (Bitvector const& lhs, Bitvector const& rhs);

Bitvector bitwise_or (Bitvector const& lhs, Bitvector const& rhs);

Bitvector bitwise_xor (Bitvector const& lhs, Bitvector const& rhs);

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 );

std::ostream& operator << ( std::ostream& out, Bitvector const& bv );

std::istream& operator >> ( std::istream& in, Bitvector& bv );

} // namespace utils
} // namespace genesis

#endif // include guard