IT++ 4.3.1
Public Member Functions | Related Symbols | List of all members
itpp::bin Class Reference

Binary arithmetic (boolean) class. More...

#include <itpp/base/binary.h>

Public Member Functions

 bin ()
 Default constructor.
 bin (const int &value)
 Set the binary object equal to value. Either "0" or "1".
 bin (const bin &inbin)
 Copy constructor.
void operator= (const int &value)
 Assign a value.
void operator= (const bin &inbin)
 Assign a value.
void operator/= (const bin &inbin)
 OR.
void operator|= (const bin &inbin)
 OR.
bin operator/ (const bin &inbin) const
 OR.
bin operator| (const bin &inbin) const
 OR.
void operator+= (const bin &inbin)
 XOR.
void operator^= (const bin &inbin)
 XOR.
bin operator+ (const bin &inbin) const
 XOR.
bin operator^ (const bin &inbin) const
 XOR.
void operator-= (const bin &inbin)
 XOR.
bin operator- (const bin &inbin) const
 XOR.
bin operator- () const
 Dummy definition to be able to use vec<bin>.
void operator*= (const bin &inbin)
 AND.
void operator&= (const bin &inbin)
 AND.
bin operator* (const bin &inbin) const
 AND.
bin operator& (const bin &inbin) const
 AND.
bin operator! (void) const
 NOT.
bin operator~ (void) const
 NOT.
bool operator== (const bin &inbin) const
 Check if equal.
bool operator== (const int &i) const
 Check if equal.
bool operator!= (const bin &inbin) const
 Check if not equal.
bool operator!= (const int &i) const
 Check if not equal.
bool operator< (const bin &inbin) const
 Less than (interpret the binary values {0,1} as integers).
bool operator<= (const bin &inbin) const
 Less than equal (interpret the binary values {0,1} as integers).
bool operator> (const bin &inbin) const
 Greater than (interpret the binary values {0,1} as integers).
bool operator>= (const bin &inbin) const
 Greater than equal (interpret the binary values {0,1} as integers).
 operator short () const
 Convert bin to short.
 operator int () const
 Convert bin to int.
 operator bool () const
 Convert bin to bool.
 operator float () const
 Convert bin to float.
 operator double () const
 Convert bin to double.
char value () const
 Output the binary value of the object.

(Note that these are not member symbols.)

ITPP_EXPORT std::ostream & operator<< (std::ostream &output, const bin &inbin)
 Output stream of bin.
ITPP_EXPORT std::istream & operator>> (std::istream &input, bin &outbin)
 Input stream of bin.
bin abs (const bin &inbin)
 absolute value of bin
int abs (const itpp::bin &inbin)
 absolute value of bin

Detailed Description

Binary arithmetic (boolean) class.

Author
Tony Ottosson

This class creates a binary arithmetic class, following the ordinary rules for binary (GF(2)) fields.

Examples:

bin a; // Creation of variable
bin a = 0; // Creating a variable and assigning it value 0
bin b = 1; // Creating a variable and assigning it value 1
bin c = a + b; // XOR operation
c = !a; // NOT
c = a * b; // AND
c = a / b; // OR
itpp::bin::bin
bin()
Default constructor.
Definition binary.h:60

Definition at line 56 of file binary.h.

Constructor & Destructor Documentation

◆ bin() [1/3]

itpp::bin::bin ( )
inline

Default constructor.

Definition at line 60 of file binary.h.

Referenced by abs(), bin(), itpp::Punctured_Turbo_Codec::calculate_punctured_size(), itpp::Modulator< T >::calculate_softbit_matrices(), itpp::Convolutional_Code::catastrophic(), itpp::Punctured_Turbo_Codec::decode(), itpp::Turbo_Codec::decode_block(), itpp::Turbo_Codec::decode_n3(), itpp::Punctured_Convolutional_Code::decode_tail(), itpp::Punctured_Convolutional_Code::decode_tailbite(), itpp::Punctured_Convolutional_Code::decode_trunc(), itpp::BPSK::demodulate_bits(), itpp::BPSK_c::demodulate_bits(), itpp::Punctured_Turbo_Codec::encode(), itpp::Punctured_Convolutional_Code::encode_tail(), itpp::Rec_Syst_Conv_Code::encode_tail(), itpp::Punctured_Convolutional_Code::encode_tailbite(), itpp::Punctured_Convolutional_Code::encode_trunc(), itpp::find(), itpp::GF2mat_sparse_alist::from_sparse(), itpp::Convolutional_Code::inverse_tail(), itpp::mxArray2bin(), itpp::mxArray2bmat(), itpp::mxArray2bvec(), operator!(), operator!=(), operator&(), operator&=(), itpp::BSC::operator()(), itpp::Vec< Num_T >::operator()(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-(), operator-=(), operator/(), operator/=(), operator<(), operator<<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), operator>>(), operator^(), operator^=(), operator|(), operator|=(), operator~(), itpp::GF2mat_sparse_alist::to_sparse(), itpp::Punctured_Convolutional_Code::weight(), itpp::Punctured_Convolutional_Code::weight(), itpp::weight(), itpp::Punctured_Convolutional_Code::weight_reverse(), and itpp::Punctured_Convolutional_Code::weight_reverse().

◆ bin() [2/3]

itpp::bin::bin ( const int & value)
inline

Set the binary object equal to value. Either "0" or "1".

Definition at line 63 of file binary.h.

References it_assert_debug, and value().

◆ bin() [3/3]

itpp::bin::bin ( const bin & inbin)
inline

Copy constructor.

Definition at line 69 of file binary.h.

References bin().

Member Function Documentation

◆ operator=() [1/2]

void itpp::bin::operator= ( const int & value)
inline

Assign a value.

Definition at line 72 of file binary.h.

References it_assert_debug, and value().

◆ operator=() [2/2]

void itpp::bin::operator= ( const bin & inbin)
inline

Assign a value.

Definition at line 79 of file binary.h.

References bin().

◆ operator/=()

void itpp::bin::operator/= ( const bin & inbin)
inline

OR.

Definition at line 82 of file binary.h.

References bin().

◆ operator|=()

void itpp::bin::operator|= ( const bin & inbin)
inline

OR.

Definition at line 85 of file binary.h.

References bin().

◆ operator/()

bin itpp::bin::operator/ ( const bin & inbin) const
inline

OR.

Definition at line 87 of file binary.h.

References bin().

◆ operator|()

bin itpp::bin::operator| ( const bin & inbin) const
inline

OR.

Definition at line 89 of file binary.h.

References bin().

◆ operator+=()

void itpp::bin::operator+= ( const bin & inbin)
inline

XOR.

Definition at line 92 of file binary.h.

References bin().

◆ operator^=()

void itpp::bin::operator^= ( const bin & inbin)
inline

XOR.

Definition at line 94 of file binary.h.

References bin().

◆ operator+()

bin itpp::bin::operator+ ( const bin & inbin) const
inline

XOR.

Definition at line 96 of file binary.h.

References bin().

◆ operator^()

bin itpp::bin::operator^ ( const bin & inbin) const
inline

XOR.

Definition at line 98 of file binary.h.

References bin().

◆ operator-=()

void itpp::bin::operator-= ( const bin & inbin)
inline

XOR.

Definition at line 100 of file binary.h.

References bin().

◆ operator-() [1/2]

bin itpp::bin::operator- ( const bin & inbin) const
inline

XOR.

Definition at line 102 of file binary.h.

References bin().

◆ operator-() [2/2]

bin itpp::bin::operator- ( ) const
inline

Dummy definition to be able to use vec<bin>.

Definition at line 104 of file binary.h.

References bin().

◆ operator*=()

void itpp::bin::operator*= ( const bin & inbin)
inline

AND.

Definition at line 107 of file binary.h.

References bin().

◆ operator&=()

void itpp::bin::operator&= ( const bin & inbin)
inline

AND.

Definition at line 109 of file binary.h.

References bin().

◆ operator*()

bin itpp::bin::operator* ( const bin & inbin) const
inline

AND.

Definition at line 111 of file binary.h.

References bin().

◆ operator&()

bin itpp::bin::operator& ( const bin & inbin) const
inline

AND.

Definition at line 113 of file binary.h.

References bin().

◆ operator!()

bin itpp::bin::operator! ( void ) const
inline

NOT.

Definition at line 116 of file binary.h.

References bin().

◆ operator~()

bin itpp::bin::operator~ ( void ) const
inline

NOT.

Definition at line 118 of file binary.h.

References bin().

◆ operator==() [1/2]

bool itpp::bin::operator== ( const bin & inbin) const
inline

Check if equal.

Definition at line 121 of file binary.h.

References bin().

◆ operator==() [2/2]

bool itpp::bin::operator== ( const int & i) const
inline

Check if equal.

Definition at line 123 of file binary.h.

◆ operator!=() [1/2]

bool itpp::bin::operator!= ( const bin & inbin) const
inline

Check if not equal.

Definition at line 126 of file binary.h.

References bin().

◆ operator!=() [2/2]

bool itpp::bin::operator!= ( const int & i) const
inline

Check if not equal.

Definition at line 128 of file binary.h.

◆ operator<()

bool itpp::bin::operator< ( const bin & inbin) const
inline

Less than (interpret the binary values {0,1} as integers).

Definition at line 131 of file binary.h.

References bin().

◆ operator<=()

bool itpp::bin::operator<= ( const bin & inbin) const
inline

Less than equal (interpret the binary values {0,1} as integers).

Definition at line 133 of file binary.h.

References bin().

◆ operator>()

bool itpp::bin::operator> ( const bin & inbin) const
inline

Greater than (interpret the binary values {0,1} as integers).

Definition at line 136 of file binary.h.

References bin().

◆ operator>=()

bool itpp::bin::operator>= ( const bin & inbin) const
inline

Greater than equal (interpret the binary values {0,1} as integers).

Definition at line 138 of file binary.h.

References bin().

◆ operator short()

itpp::bin::operator short ( ) const
inline

Convert bin to short.

Definition at line 141 of file binary.h.

◆ operator int()

itpp::bin::operator int ( ) const
inline

Convert bin to int.

Definition at line 143 of file binary.h.

◆ operator bool()

itpp::bin::operator bool ( ) const
inline

Convert bin to bool.

Definition at line 145 of file binary.h.

◆ operator float()

itpp::bin::operator float ( ) const
inline

Convert bin to float.

Definition at line 147 of file binary.h.

◆ operator double()

itpp::bin::operator double ( ) const
inline

Convert bin to double.

Definition at line 149 of file binary.h.

◆ value()

char itpp::bin::value ( ) const
inline

Output the binary value of the object.

Definition at line 152 of file binary.h.

Referenced by bin(), itpp::it_file::low_level_write(), itpp::it_file_old::low_level_write(), and operator=().

◆ operator<<()

ITPP_EXPORT std::ostream & operator<< ( std::ostream & output,
const bin & inbin )
related

Output stream of bin.

Definition at line 36 of file binary.cpp.

References bin(), and operator<<().

Referenced by operator<<().

◆ operator>>()

ITPP_EXPORT std::istream & operator>> ( std::istream & input,
bin & outbin )
related

Input stream of bin.

Definition at line 42 of file binary.cpp.

References bin(), it_assert, and operator>>().

Referenced by operator>>().

◆ abs() [1/2]

bin abs ( const bin & inbin)
related

absolute value of bin

Definition at line 174 of file binary.h.

References bin().

◆ abs() [2/2]

int abs ( const itpp::bin & inbin)
related

absolute value of bin

Definition at line 186 of file binary.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0