fcml  1.2.2
Public Types | Public Member Functions | List of all members
fcml::Decorators Class Reference

Holds operand decorators. More...

#include <fcml_common.hpp>

Public Types

enum  EmbeededRoundingControl {
  FCML_ERC_RNE = 0,
  FCML_ERC_RD,
  FCML_ERC_RU,
  FCML_ERC_RZ
}
 Rounding mode.
 

Public Member Functions

 Decorators ()
 Creates an empty operand decorators container. More...
 
DecoratorssetZ (fcml_bool z)
 Sets a new AVX-512 {z} decorator. More...
 
DecoratorssetBcast (const Nullable< fcml_uint8_t > &bcast)
 Sets a new AVX-512 {bcast} decorator. More...
 
DecoratorssetOpmaskReg (const Register &opmaskReg)
 Sets AVX-512 opmask register for {k} decorator. More...
 
DecoratorssetEr (const Nullable< EmbeededRoundingControl > &er)
 Sets AVX-512 {er} decorator. More...
 
DecoratorssetSae (const fcml_bool sae)
 Sets AVX-512 {sae} decorator. More...
 
fcml_bool isZ () const
 Gets AVX-512 {z} operator. More...
 
const Nullable< fcml_uint8_t > & getBcast () const
 Gets AVX-512 {bcast} decorator. More...
 
const RegistergetOpmaskReg () const
 Gets constant AVX-512 opmask register for {k} decorator. More...
 
RegistergetOpmaskReg ()
 Gets AVX-512 opmask register for {k} decorator. More...
 
const Nullable< EmbeededRoundingControl > & getEr () const
 Gets AVX-512 {er} decorator. More...
 
fcml_bool isSae () const
 Gets AVX-512 {sae} decorator. More...
 
bool operator== (const Decorators &decorators) const
 Checks if two decorators containers are equal or not. More...
 
bool operator!= (const Decorators &decorators) const
 Checks if two decorators are equal or not. More...
 

Detailed Description

Holds operand decorators.

Since
1.2.0

Constructor & Destructor Documentation

◆ Decorators()

fcml::Decorators::Decorators ( )
inline

Creates an empty operand decorators container.

Since
1.2.0

Member Function Documentation

◆ getBcast()

const Nullable<fcml_uint8_t>& fcml::Decorators::getBcast ( ) const
inline

Gets AVX-512 {bcast} decorator.

Returns
Value of {bcast} decorator.
Since
1.2.0

◆ getEr()

const Nullable<EmbeededRoundingControl>& fcml::Decorators::getEr ( ) const
inline

Gets AVX-512 {er} decorator.

Returns
Value of {er} decorator.
Since
1.2.0

◆ getOpmaskReg() [1/2]

const Register& fcml::Decorators::getOpmaskReg ( ) const
inline

Gets constant AVX-512 opmask register for {k} decorator.

Returns
Opmask register.
Since
1.2.0

◆ getOpmaskReg() [2/2]

Register& fcml::Decorators::getOpmaskReg ( )
inline

Gets AVX-512 opmask register for {k} decorator.

Returns
Opmask register.
Since
1.2.0

◆ isSae()

fcml_bool fcml::Decorators::isSae ( ) const
inline

Gets AVX-512 {sae} decorator.

Returns
True if {sae} is set.
Since
1.2.0

◆ isZ()

fcml_bool fcml::Decorators::isZ ( ) const
inline

Gets AVX-512 {z} operator.

Returns
{z} operator.
Since
1.2.0

◆ operator!=()

bool fcml::Decorators::operator!= ( const Decorators decorators) const
inline

Checks if two decorators are equal or not.

Parameters
decoratorsDecorators.
Returns
True if they are NOT equal.
Since
1.2.0

◆ operator==()

bool fcml::Decorators::operator== ( const Decorators decorators) const
inline

Checks if two decorators containers are equal or not.

Parameters
decoratorsDecorators.
Returns
True if they are equal.
Since
1.2.0

◆ setBcast()

Decorators& fcml::Decorators::setBcast ( const Nullable< fcml_uint8_t > &  bcast)
inline

Sets a new AVX-512 {bcast} decorator.

Parameters
bcastDecorator value.
Returns
Decorators..
Since
1.2.0

◆ setEr()

Decorators& fcml::Decorators::setEr ( const Nullable< EmbeededRoundingControl > &  er)
inline

Sets AVX-512 {er} decorator.

Parameters
er{er} decorator.
Since
1.2.0

◆ setOpmaskReg()

Decorators& fcml::Decorators::setOpmaskReg ( const Register opmaskReg)
inline

Sets AVX-512 opmask register for {k} decorator.

Parameters
opmaskRegOpmask register.
Since
1.2.0

◆ setSae()

Decorators& fcml::Decorators::setSae ( const fcml_bool  sae)
inline

Sets AVX-512 {sae} decorator.

Parameters
sae{sae} decorator.
Since
1.2.0

◆ setZ()

Decorators& fcml::Decorators::setZ ( fcml_bool  z)
inline

Sets a new AVX-512 {z} decorator.

Parameters
z{z} decorator.
Returns
Decorators.
Since
1.2.0

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