BMat8

This page describes the class BMat8 that are an optimized representation of boolean matrices of dimension at most \(8\).

For boolean matrices of higher dimensions see BMat.

Adapters for BMat8 objects are documented here.

Namespaces
namespace	libsemigroups::bmat8
	Namespace for BMat8 helper functions.

Classes
class	BMat8
	Fast boolean matrices of dimension up to 8 x 8. More...

Functions
constexpr BMat8	operator* (bool scalar, BMat8 const &x) noexcept
	Multiplication operator.
std::ostream &	operator<< (std::ostream &os, BMat8 const &x)
	Insertion operator.
std::ostringstream &	operator<< (std::ostringstream &os, BMat8 const &x)
	Insertion operator.
std::string	to_human_readable_repr (BMat8 const &x, std::string const &braces="{}")
	Returns a string representation.

Function Documentation

operator*()

BMat8 operator* ( bool scalar, BMat8 const & x )

nodiscardconstexprnoexcept

This function allows BMat8 objects to be multiplied by scalars.

Parameters

scalar	a boolean scalar.
x	the matrix.

Returns

The product scalar * x.

operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	os,
		BMat8 const &	x )

This function allows BMat8 objects to be inserted into a std::ostream.

operator<<() [2/2]

std::ostringstream & operator<<	(	std::ostringstream &	os,
		BMat8 const &	x )

This function allows BMat8 objects to be inserted into an std::ostringstream.

to_human_readable_repr()

std::string to_human_readable_repr	(	BMat8 const &	x,
		std::string const &	braces = "{}" )

Parameters

x	the matrix.
braces	the type of braces to use in the returned string (default: "{}").

Returns

A string containing a representation of x.