diff --git a/wrapper/matlab/+matfaust/@Faust/Faust.m b/wrapper/matlab/+matfaust/@Faust/Faust.m index 792329dce4fb951f2b87a891dac8d56ccadcd1c7..8e07d5d3766ea8fa969f640c2c60aba1f61ddf28 100644 --- a/wrapper/matlab/+matfaust/@Faust/Faust.m +++ b/wrapper/matlab/+matfaust/@Faust/Faust.m @@ -2305,6 +2305,24 @@ classdef Faust %=== %> %> @retval dev: the Faust device. + %> + %> @b Example: + %>@code + %> >> cpuF = matfaust.rand(5, 5, 'dev', 'cpu'); + %> >> device(cpuF) + %> + %> ans = + %> + %> 'cpu' + %> + %> >> gpuF = matfaust.rand(5,5, 'dev', 'gpu'); + %> >> device(gpuF) + %> + %> ans = + %> + %> 'gpu' + %>@endcode + %> %================================================================ function dev = device(F) dev = F.dev; diff --git a/wrapper/python/pyfaust.py b/wrapper/python/pyfaust.py index 34e9450736b00076c1ff7cedaab9c1a66e424642..dfdd24b455cc479a7ff0562fb3991319e53f5e20 100644 --- a/wrapper/python/pyfaust.py +++ b/wrapper/python/pyfaust.py @@ -342,7 +342,16 @@ class Faust(numpy.lib.mixins.NDArrayOperatorsMixin): @property def device(self): """ - Returns the device on which the Faust is located (cpu or gpu). + Returns the device on which the Faust is located ('cpu' or 'gpu'). + + Example: + >>> import pyfaust as pf + >>> cpuF = pf.rand(5, 5, dev='cpu') + >>> cpuF.device + 'cpu' + >>> gpuF = pf.rand(5, 5, dev='gpu') + >>> gpuF.device + 'gpu' """ return self.m_faust.device()