SeqAn3 3.1.0
The Modern C++ library for sequence analysis.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
enum_bitwise_operators Interface Reference

You can expect these functions on all types that overload seqan3::add_enum_bitwise_operators. More...

#include <seqan3/core/add_enum_bitwise_operators.hpp>

Related Functions

(Note that these are not member functions.)

Requirements for seqan3::enum_bitwise_operators

You can expect these member functions.

 operator& (t lhs, t rhs)
 Returns the binary & operator of lhs and rhs. More...
 
 operator| (t lhs, t rhs)
 Returns the binary | operator of lhs and rhs. More...
 
 operator^ (t lhs, t rhs)
 Returns the binary ^ operator of lhs and rhs. More...
 
 operator~ (t lhs)
 Returns the binary ~ operator of lhs. More...
 
 operator&= (t &lhs, t rhs)
 Returns the binary &= operator of lhs and rhs. More...
 
 operator|= (t &lhs, t rhs)
 Returns the binary |= operator of lhs and rhs. More...
 
 operator^= (t &lhs, t rhs)
 Returns the binary ^= operator of lhs and rhs. More...
 

Detailed Descriptionno-api

You can expect these functions on all types that overload seqan3::add_enum_bitwise_operators.

Friends And Related Function Documentation

◆ operator&() [no-api]

operator& ( lhs,
rhs 
)
no-apirelated

Returns the binary & operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary conjunction of lhs and rhs.

◆ operator&=() [no-api]

operator&= ( t &  lhs,
rhs 
)
no-apirelated

Returns the binary &= operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary AND assigment on lhs.

◆ operator^() [no-api]

operator^ ( lhs,
rhs 
)
no-apirelated

Returns the binary ^ operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary XOR operation on lhs and rhs.

◆ operator^=() [no-api]

operator^= ( t &  lhs,
rhs 
)
no-apirelated

Returns the binary ^= operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary XOR assignment on lhs.

◆ operator|() [no-api]

operator| ( lhs,
rhs 
)
no-apirelated

Returns the binary | operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary disjunction of lhs and rhs.

◆ operator|=() [no-api]

operator|= ( t &  lhs,
rhs 
)
no-apirelated

Returns the binary |= operator of lhs and rhs.

Parameters
lhsFirst enum.
rhsSecond enum.
Returns
the binary OR assignment on lhs.

◆ operator~() [no-api]

operator~ ( lhs)
no-apirelated

Returns the binary ~ operator of lhs.

Parameters
lhsFirst enum.
Returns
the binary NOT operation on lhs.

The documentation for this interface was generated from the following file: