KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QRandomGenerator

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QRandomGenerator

Public constructors

new QRandomGeneratornew(unsigned int seedValue = 1)Constructor QRandomGenerator::QRandomGenerator(quint32 seedValue)
new QRandomGeneratornew(const QRandomGenerator other)Constructor QRandomGenerator::QRandomGenerator(const QRandomGenerator &other)

Public methods

[const]bool!=(const QRandomGenerator rng2)Operator bool ::operator!=(const QRandomGenerator &rng1, const QRandomGenerator &rng2)
unsigned int()Method quint32 QRandomGenerator::operator()()
void_assign(const QRandomGenerator other)Assigns another object to self
[const]QRandomGenerator ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QRandomGeneratorassign(const QRandomGenerator other)Method QRandomGenerator &QRandomGenerator::operator=(const QRandomGenerator &other)
doublebounded(double highest)Method double QRandomGenerator::bounded(double highest)
unsigned intbounded(unsigned int highest)Method quint32 QRandomGenerator::bounded(quint32 highest)
unsigned intbounded(unsigned int lowest,
unsigned int highest)
Method quint32 QRandomGenerator::bounded(quint32 lowest, quint32 highest)
intbounded(int highest)Method int QRandomGenerator::bounded(int highest)
intbounded(int lowest,
int highest)
Method int QRandomGenerator::bounded(int lowest, int highest)
voiddiscard(unsigned long long z)Method void QRandomGenerator::discard(unsigned long long int z)
[const]new QRandomGenerator ptrdupCreates a copy of self
unsigned intgenerateMethod quint32 QRandomGenerator::generate()
voidgenerate(unsigned int ptr begin,
unsigned int ptr end)
Method void QRandomGenerator::generate(quint32 *begin, quint32 *end)
unsigned long longgenerate64Method quint64 QRandomGenerator::generate64()
doublegenerateDoubleMethod double QRandomGenerator::generateDouble()
voidseed(unsigned int s = 1)Method void QRandomGenerator::seed(quint32 s)

Public static methods and constants

QRandomGenerator ptrglobalStatic method QRandomGenerator *QRandomGenerator::global()
unsigned intmaxStatic method quint32 QRandomGenerator::max()
unsigned intminStatic method quint32 QRandomGenerator::min()
QRandomGeneratorsecurelySeededStatic method QRandomGenerator QRandomGenerator::securelySeeded()
QRandomGenerator ptrsystemStatic method QRandomGenerator *QRandomGenerator::system()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QRandomGenerator rng2)

Description: Operator bool ::operator!=(const QRandomGenerator &rng1, const QRandomGenerator &rng2)

This is the mapping of the global operator to the instance method.

()

Signature: unsigned int ()

Description: Method quint32 QRandomGenerator::operator()()

_assign

Signature: void _assign (const QRandomGenerator other)

Description: Assigns another object to self

_const_cast

Signature: [const] QRandomGenerator ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QRandomGenerator assign (const QRandomGenerator other)

Description: Method QRandomGenerator &QRandomGenerator::operator=(const QRandomGenerator &other)

bounded

(1) Signature: double bounded (double highest)

Description: Method double QRandomGenerator::bounded(double highest)

(2) Signature: unsigned int bounded (unsigned int highest)

Description: Method quint32 QRandomGenerator::bounded(quint32 highest)

(3) Signature: unsigned int bounded (unsigned int lowest, unsigned int highest)

Description: Method quint32 QRandomGenerator::bounded(quint32 lowest, quint32 highest)

(4) Signature: int bounded (int highest)

Description: Method int QRandomGenerator::bounded(int highest)

(5) Signature: int bounded (int lowest, int highest)

Description: Method int QRandomGenerator::bounded(int lowest, int highest)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

discard

Signature: void discard (unsigned long long z)

Description: Method void QRandomGenerator::discard(unsigned long long int z)

dup

Signature: [const] new QRandomGenerator ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

generate

(1) Signature: unsigned int generate

Description: Method quint32 QRandomGenerator::generate()

(2) Signature: void generate (unsigned int ptr begin, unsigned int ptr end)

Description: Method void QRandomGenerator::generate(quint32 *begin, quint32 *end)

generate64

Signature: unsigned long long generate64

Description: Method quint64 QRandomGenerator::generate64()

generateDouble

Signature: double generateDouble

Description: Method double QRandomGenerator::generateDouble()

global

Signature: [static] QRandomGenerator ptr global

Description: Static method QRandomGenerator *QRandomGenerator::global()

This method is static and can be called without an instance.

Python specific notes:
This attribute is available as 'global_' in Python.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

max

Signature: [static] unsigned int max

Description: Static method quint32 QRandomGenerator::max()

This method is static and can be called without an instance.

min

Signature: [static] unsigned int min

Description: Static method quint32 QRandomGenerator::min()

This method is static and can be called without an instance.

new

(1) Signature: [static] new QRandomGenerator new (unsigned int seedValue = 1)

Description: Constructor QRandomGenerator::QRandomGenerator(quint32 seedValue)

This method creates an object of class QRandomGenerator.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QRandomGenerator new (const QRandomGenerator other)

Description: Constructor QRandomGenerator::QRandomGenerator(const QRandomGenerator &other)

This method creates an object of class QRandomGenerator.

Python specific notes:
This method is the default initializer of the object.

securelySeeded

Signature: [static] QRandomGenerator securelySeeded

Description: Static method QRandomGenerator QRandomGenerator::securelySeeded()

This method is static and can be called without an instance.

seed

Signature: void seed (unsigned int s = 1)

Description: Method void QRandomGenerator::seed(quint32 s)

system

Signature: [static] QRandomGenerator ptr system

Description: Static method QRandomGenerator *QRandomGenerator::system()

This method is static and can be called without an instance.