libsemigroups  v3.0.0
C++ library for semigroups and monoids
Loading...
Searching...
No Matches
make<Bipartition>

This page contains documentation related to safely constructing a Bipartition instance.

See also
The `make` function for an overview of possible uses of the this function.

Functions

template<typename Return, typename Container>
enable_if_is_same< Return, Bipartitionmake (Container const &cont)
 Check the arguments, construct a bipartition, and check it.
 
template<typename Return>
enable_if_is_same< Return, Bipartitionmake (std::initializer_list< std::vector< int32_t > > const &cont)
 Check the arguments, construct a Blocks object, and check it.
 
template<typename Return>
enable_if_is_same< Return, Bipartitionmake (std::initializer_list< uint32_t > const &cont)
 Check the arguments, construct a bipartition, and check it.
 

Function Documentation

◆ make() [1/3]

template<typename Return, typename Container>
enable_if_is_same< Return, Bipartition > make ( Container const & cont)
nodiscard
Template Parameters
Containerthe type of the parameter cont.
Returnthe return type. Must satisfy std::is_same<Return, Bipartition>.
Parameters
conteither a vector providing a lookup for the blocks of the bipartition or a vector of vectors (or initializer list).
Exceptions
LibsemigroupsExceptionif the arguments do not describe a bipartition.
LibsemigroupsExceptionif the constructed bipartition is not valid.

◆ make() [2/3]

template<typename Return>
enable_if_is_same< Return, Bipartition > make ( std::initializer_list< std::vector< int32_t > > const & cont)
nodiscard
Template Parameters
Containerthe type of the parameter cont.
Returnthe return type. Must satisfy std::is_same<Return, Blocks>.
Parameters
contcontainer containing a lookup for the blocks.
Exceptions
LibsemigroupsExceptionif the arguments do not describe a signed partition.
LibsemigroupsExceptionif the constructed Blocks object is not valid.

◆ make() [3/3]

template<typename Return>
enable_if_is_same< Return, Bipartition > make ( std::initializer_list< uint32_t > const & cont)
nodiscard

Check the arguments, construct a Blocks object, and check it.

Template Parameters
Containerthe type of the parameter cont.
Returnthe return type. Must satisfy std::is_same<Return, Blocks>.
Parameters
contcontainer containing a lookup for the blocks.
Exceptions
LibsemigroupsExceptionif the arguments do not describe a signed partition.
LibsemigroupsExceptionif the constructed Blocks object is not valid.