A class that computes permutation. More...

#include <Permutation.h>

Inheritance diagram for FLImaging::Foundation::CPermutation:

Public Member Functions
	CPermutation ()

virtual	~CPermutation ()

void	Clear ()

void	SetSelection (int32_t i32Selection)

void	SetMax (int32_t i32Max)

void	Calculate ()

const Base::CFLArray< Base::CFLArray< int32_t > > &	GetResult ()

Public Member Functions inherited from FLImaging::Base::CFLBase
	CFLBase ()
	Default constructor.

virtual	~CFLBase ()
	Destructor.

void	Lock () const
	Set a lock on an object.

bool	TryLock () const
	Try to lock the object.

void	Unlock () const
	Unlock the object.

virtual const CProcessingUnitBase *	GetProcessingUnit () const
	Returns the set ProcessingUnit.

virtual const CResult	SetProcessingUnit (const CProcessingUnitBase &pub)
	set the ProcessingUnit

virtual const CResult	SetProcessingUnit (const CProcessingUnitBase *pPub)
	Set the ProcessingUnit.

virtual void	ResetProcessingUnit ()
	Rest the ProcessingUnit.

virtual bool	IsValid () const
	Validate the object.

template<class T >
bool	IsValid (T &tValue) const
	Validate input values.

template<class T >
bool	IsValid (T *pTValue) const
	Validate input values.

template<class T >
void	GenerateMin (T &tValue) const
	Generate the minimum value of that type.

template<class T >
void	GenerateMin (T *pTValue) const
	Generate the minimum value of that type.

template<class T >
void	GenerateMinInt32 (T &tValue) const
	Generate minimum signed 32-bit integer value.

template<class T >
void	GenerateMinInt32 (T *pTValue) const
	Generate minimum signed 32-bit integer value.

template<class T >
void	GenerateMinInt31 (T &tValue) const
	Generate minimum signed 31-bit integer value.

template<class T >
void	GenerateMinInt31 (T *pTValue) const
	Generate minimum signed 31-bit integer value.

template<class T >
void	GenerateMax (T &tValue) const
	Generate the maximum value of that type.

template<class T >
void	GenerateMax (T *pTValue) const
	Generate the maximum value of that type.

template<class T >
void	GenerateMaxInt32 (T &tValue) const
	Generate maximum signed 32-bit integer value.

template<class T >
void	GenerateMaxInt32 (T *pTValue) const
	Generate maximum signed 32-bit integer value.

template<class T >
void	GenerateMaxInt31 (T &tValue) const
	Generate maximum signed 31-bit integer value.

template<class T >
void	GenerateMaxInt31 (T *pTValue) const
	Generate maximum signed 31-bit integer value.

template<class T >
void	GenerateInvalid (T &tValue) const
	Generate invalid value.

template<class T >
void	GenerateInvalid (T *pTValue) const
	Generate invalid value.

virtual void	OnReceiveBroadcast (const CBroadcastMessage *pMessage)
	Callback function. A function that receives a BroadcastMessage.

virtual int64_t	GetClassType () const =0
	Returns the Type value of Class. The returned value itself has no meaning, but if it is the same type of class, the same value will be displayed, so comparison is possible.

const char *	GetClassNameWithNamespace () const
	Returns the class name including the namespace of the actual instance.

const char *	GetClassNameWithoutNamespace () const
	Returns the class name that does not include the namespace of the actual instance.

virtual uint32_t	GetClassHash () const
	Returns the class hash value of the actual instance. For the same class, even if the instance is different, it has the same value.

virtual bool	IsLicenseAvailable () const
	Returns whether the algorithm can be used with the current license.

const CResult	ShareSynchronizationObject (const CFLBase *pSrcObject) const
	Share synchronization object of original object.

bool	IsSharedSynchronizationObject () const
	Is shared synchronization object.

virtual void	Throw (const CResult &res, const wchar_t *pWcsExtraMessage=nullptr) const
	Raise an exception. Information and error codes of the object that occurred are recorded in the log.

virtual void	Throw (const std::exception &res, const wchar_t *pWcsExtraMessage) const
	Raise an exception. Information and error codes of the object that occurred are recorded in the log.

Detailed Description

A class that computes permutation.

Constructor & Destructor Documentation

◆ CPermutation()

FLImaging::Foundation::CPermutation::CPermutation ( )

Default constructor

◆ ~CPermutation()

virtual FLImaging::Foundation::CPermutation::~CPermutation ( )

virtual

Default destructor

Member Function Documentation

◆ Calculate()

void FLImaging::Foundation::CPermutation::Calculate ( )

Calculate a permutation based on member variables set in the permutation object

◆ Clear()

void FLImaging::Foundation::CPermutation::Clear ( )

Initialize object variables

◆ GetResult()

const Base::CFLArray< Base::CFLArray< int32_t > > & FLImaging::Foundation::CPermutation::GetResult ( )

Returns the computed permutation as a two-dimensional array

Return values

FLImaging::Base::CFLArray<FLImaging::Base::CFLArray<int32_t>> A reference to a two-dimensional array of computed permutations

See also: FLImaging::Base::CFLArray

◆ SetMax()

void FLImaging::Foundation::CPermutation::SetMax ( int32_t i32Max )

Specify the maximum value of permutation

Parameters

[in] i32Max max of permutation

◆ SetSelection()

void FLImaging::Foundation::CPermutation::SetSelection ( int32_t i32Selection )

Specify how many to choose from permutation