Settings¶
This page contains information about the methods of the FroidurePin
that control various settings.
- FroidurePin.batch_size(self: FroidurePin, val: int) FroidurePin¶
Set a new value for the batch size.
- Parameters
val (int) - the new value for the batch size.
- Returns
The calling instance returns itself.
- FroidurePin.batch_size(self: FroidurePin) int
Returns the current value of the batch size.
- Parameters
None
- Returns
An
int.
- FroidurePin.concurrency_threshold(self: FroidurePin, val: int) FroidurePin¶
Set the threshold for concurrency to be used by methods of
FroidurePin.- Parameters
val (int) - the new threshold.
- Returns
The calling instance returns itself.
- FroidurePin.concurrency_threshold(self: FroidurePin) int
Returns the current value of the concurrency threshold.
- Parameters
None
- Returns
An
int.
- FroidurePin.immutable(self: FroidurePin, val: int) FroidurePin¶
Set immutability.
- Parameters
val (bool) - the new value.
- Returns
The calling instance returns itself.
- FroidurePin.immutable(self: FroidurePin) int
Returns the current value of immutability.
- Parameters
None
- Returns
A
bool.
- FroidurePin.max_threads(self: FroidurePin, val: int) FroidurePin¶
Set the maximum number of threads.
- Parameters
number_of_threads (int) - the maximum number of threads to use.
- Returns
The calling instance returns itself.
- FroidurePin.max_threads(self: FroidurePin) int
Returns the current value of the maximum number of threads.
- Parameters
None
- Returns
An
int.
- FroidurePin.reserve(self: FroidurePin, val: int) None¶
Requests the given capacity for elements.
- Parameters
val (int) -- the number of elements to reserve space for.
- Returns
None