Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 60e38727 authored by hhakim's avatar hhakim
Browse files

Review/Update Faust.left/right functions.

parent 01a64f02
No related branches found
No related tags found
No related merge requests found
...@@ -1246,7 +1246,13 @@ classdef Faust ...@@ -1246,7 +1246,13 @@ classdef Faust
%================================================================ %================================================================
%> Returns the left hand side factors of F from index 1 to i included (in 1-base index). %> Returns the left hand side factors of F from index 1 to i included (in 1-base index).
%=== %===
%> @Example %>
%>
%> @retval a Faust if the number of factors to be returned is greater than 1,
%> an array or a sparse matrix otherwise.
%>
%> @b Example
%>
%> @code %> @code
%> %in a matlab terminal %> %in a matlab terminal
%> >> F = matfaust.rand(8, 5) %> >> F = matfaust.rand(8, 5)
...@@ -1280,7 +1286,12 @@ classdef Faust ...@@ -1280,7 +1286,12 @@ classdef Faust
%> Returns the right hand side factors of F from index i to end (in 1-base index). %> Returns the right hand side factors of F from index i to end (in 1-base index).
%=== %===
%> %>
%> @Example %> @retval a Faust if the number of factors to be returned is greater than 1,
%> an array or a sparse matrix otherwise.
%>
%>
%> @b Example
%>
%> @code %> @code
%> >> F = matfaust.rand(7,7, 'dim_sizes', [7, 10]) %> >> F = matfaust.rand(7,7, 'dim_sizes', [7, 10])
%> %>
......
...@@ -1750,8 +1750,8 @@ class Faust(numpy.lib.mixins.NDArrayOperatorsMixin): ...@@ -1750,8 +1750,8 @@ class Faust(numpy.lib.mixins.NDArrayOperatorsMixin):
Returns the right hand side factors of F from index i to F.numfactors()-1. Returns the right hand side factors of F from index i to F.numfactors()-1.
Returns: Returns:
a Faust if the size factor set to be returned is greater than 1, a a Faust if the number of factors to be returned is greater than 1, a
numpy array otherwise. numpy array or a sparse matrix otherwise.
Examples: Examples:
>>> from pyfaust import rand >>> from pyfaust import rand
...@@ -1786,8 +1786,8 @@ class Faust(numpy.lib.mixins.NDArrayOperatorsMixin): ...@@ -1786,8 +1786,8 @@ class Faust(numpy.lib.mixins.NDArrayOperatorsMixin):
Returns the left hand side factors of F from index 0 to i included. Returns the left hand side factors of F from index 0 to i included.
Returns: Returns:
a Faust if the size of factor set to be returned is greater than 1, a a Faust if the number of factors to be returned is greater than 1, a
numpy array otherwise. numpy array or a sparse matrix otherwise.
Examples: Examples:
>>> from pyfaust import rand >>> from pyfaust import rand
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment