def set_nthreads(nthreads):
"""
set_nthreads(nthreads)
Set the number of threads to be used during Blosc operation.
Parameters
----------
nthreads : int
The number of threads to be used during Blosc operation.
Returns
-------
out : int
The previous number of used threads.
Raises
------
ValueError
If nthreads is larger that the maximum number of threads blosc can use.
Notes
-----
The number of threads for Blosc is the maximum number of cores
detected on your machine (via `detect_number_of_cores`). In some
cases Blosc gets better results if you set the number of threads
to a value slightly below than your number of cores.
Examples
--------
Set the number of threads to 2 and then to 1:
>>> oldn = blosc.set_nthreads(2)
>>> blosc.set_nthreads(1)
2
"""
if nthreads > blosc.MAX_THREADS:
raise ValueError("the number of threads cannot be larger than %d" %
blosc.MAX_THREADS)
blosc.nthreads = nthreads
return _ext.set_nthreads(nthreads)
def set_nthreads(nthreads):
"""
set_nthreads(nthreads)
Set the number of threads to be used during Blosc operation.
Parameters
----------
nthreads : int
The number of threads to be used during Blosc operation.
Returns
-------
out : int
The previous number of used threads.
Raises
------
ValueError
If nthreads is larger that the maximum number of threads blosc can use.
Notes
-----
The number of threads for Blosc is the maximum number of cores
detected on your machine (via `detect_number_of_cores`). In some
cases Blosc gets better results if you set the number of threads
to a value slightly below than your number of cores.
Examples
--------
Set the number of threads to 2 and then to 1:
>>> oldn = blosc.set_nthreads(2)
>>> blosc.set_nthreads(1)
2
"""
if nthreads > blosc.MAX_THREADS:
raise ValueError("the number of threads cannot be larger than %d" %
blosc.MAX_THREADS)
return _ext.set_nthreads(nthreads)
