Exceptional GitLab maintenance is scheduled for June 24, 2025. The service will be unavailable between 8:00 am and 9:30 am. Please do not work on the platform until an announcement indicates that maintenance is complete.
/* Copyright 2015-2019 The MathWorks, Inc. *//* In this file, styles are not scoped to rtcContainer since they could be in the Dojo Tooltip */.diagnosticMessage-wrapper{font-family:Menlo,Monaco,Consolas,"Courier New",monospace;font-size:12px;}
- FACTOR 4 (double) DENSE, size 100x100, density 1, nnz 10000</div></div></div></div></div></div><divclass = 'S7'><span>As you noticed, the </span><spanstyle=' font-family: monospace;'>Faust</span><span> output contains the list of factors and their features but also a header describing the </span><spanstyle=' font-family: monospace;'>Faust</span><span> operator itself: its size, its density, the number of nonzeros it contains (</span><spanstyle=' font-family: monospace;'>nnz_sum</span><span>) along with all its factors.</span></div><divclass = 'S1'><span>You can also call </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html#a3132f572e58e6c312d5535d0e075735e"><spanstyle=' font-family: monospace;'>disp(F)</span></a><span> to get all the information.</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre;"><span>disp(F)</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsTextElement"uid="6B9931EE"data-testid="output_1"data-width="832"data-height="87"data-hashorizontaloverflow="false"style="width: 862px; max-height: 261px;"><divclass="textElement">Faust size 100x100, density 3.1898, nnz_sum 31898, 5 factor(s):
</div></div></div></div></div></div><divclass = 'S7'><span>As you noticed, the </span><spanstyle=' font-family: monospace;'>Faust</span><span> output contains the list of factors and their features but also a header describing the </span><spanstyle=' font-family: monospace;'>Faust</span><span> operator itself: its size, its density, the number of nonzeros it contains (</span><spanstyle=' font-family: monospace;'>nnz_sum</span><span>) along with all its factors.</span></div><divclass = 'S1'><span>You can also call </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html#a3132f572e58e6c312d5535d0e075735e"><spanstyle=' font-family: monospace;'>disp(F)</span></a><span> to get all the information.</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre"><span>disp(F)</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsTextElement"uid="417A60C5"data-testid="output_1"style="width: 716px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divclass="textElement eoOutputContent"data-width="686"data-height="90"data-hashorizontaloverflow="false"style="max-height: 261px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">Faust size 100x100, density 3.1897, nnz_sum 31897, 5 factor(s):
- FACTOR 4 (double) DENSE, size 100x100, density 1, nnz 10000</div></div></div></div></div><divclass = 'S7'><span>Note that when you don't need </span><spanstyle=' font-family: monospace;'>F</span><span> anymore, you can delete it with the instruction </span><spanstyle=' font-family: monospace;'>delete(F)</span><span> or </span><spanstyle=' font-family: monospace;'>clear F</span><span>. Normally, that's the role of the garbage collector but it might happen that your Faust is very eager in memory and a manual deletion is necessary.</span></div><h3class = 'S2'><spanstyle=' font-weight: bold;'>2. Faust File Loading</span></h3><divclass = 'S1'><spanstyle=' font-weight: bold;'></span></div><divclass = 'S1'><span>It's really handy to create a </span><spanstyle=' font-family: monospace;'>Faust</span><span> and retrieve it from a file later. Let's see in the code below how to proceed.</span></div><divclass = 'S1'><span>First save the Faust.</span></div><divclass="CodeBlock"><divclass="inlineWrapper"><divclass = 'S9'><spanstyle="white-space: pre"><span>save(F, </span><spanstyle="color: rgb(170, 4, 249);">'F.mat'</span><span>)</span></span></div></div></div><divclass = 'S7'><span>Now let's get it back from file.</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre"><span>file_F = Faust(</span><spanstyle="color: rgb(170, 4, 249);">'F.mat'</span><span>)</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement"uid="A03641CF"data-testid="output_2"style="width: 716px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divclass="textElement eoOutputContent"data-width="686"data-height="107"data-hashorizontaloverflow="false"style="max-height: 261px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divstyle="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><spanclass="variableNameElement"style="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">file_F = </span></div><divstyle="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">Faust size 100x100, density 3.1897, nnz_sum 31897, 5 factor(s):
- FACTOR 4 (double) DENSE, size 100x100, density 1, nnz 10000</div></div></div></div></div></div><divclass = 'S7'><span>The file storage format used is matlab v7. This format allows the compatibility between matfaust and </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacepyfaust.html"><span>pyfaust</span></a><span>, the Python wrapper. You can easily reload the </span><spanstyle=' font-family: monospace;'>F.mat</span><span> file from pyfaust.</span></div><divclass = 'S1'><span></span></div><h3class = 'S2'><span>3. Generating a Random Faust</span></h3><divclass = 'S1'><span></span></div><divclass = 'S1'><span>The matfaust package provides functions for generating </span><spanstyle=' font-family: monospace;'>Faust</span><span> objects by many manners. One noticeable function of this package is </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8"><span>rand()</span></a><span>. This function allows to generate a random </span><spanstyle=' font-family: monospace;'>Faust</span><span> satisfying certain constraints; the number of factors, the size of these factors, the density, the scalar type, etc.</span></div><divclass = 'S1'><span>Below are examples of (pseudo-)random generations.</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre;"><span>F = matfaust.rand(10, 10, </span><spanstyle="color: rgb(160, 32, 240);">'num_factors'</span><span>, 2, </span><spanstyle="color: rgb(160, 32, 240);">'density'</span><span>, .5, </span><spanstyle="color: rgb(160, 32, 240);">'field'</span><span>, </span><spanstyle="color: rgb(160, 32, 240);">'complex'</span><span>)</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement"uid="93C200CD"data-testid="output_3"data-width="832"data-height="62"data-hashorizontaloverflow="false"style="width: 862px; max-height: 261px;"><divclass="textElement"><div><spanclass="variableNameElement">F = </span></div><div>Faust size 10x10, density 1, nnz_sum 100, 2 factor(s):
</div></div></div></div></div></div><divclass = 'S7'><span>The file storage format used is matlab v7. This format allows the compatibility between matfaust and </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacepyfaust.html"><span>pyfaust</span></a><span>, the Python wrapper. You can easily reload the </span><spanstyle=' font-family: monospace;'>F.mat</span><span> file from pyfaust.</span></div><divclass = 'S1'><span></span></div><h3class = 'S2'><span>3. Generating a Random Faust</span></h3><divclass = 'S1'><span></span></div><divclass = 'S1'><span>The matfaust package provides functions for generating </span><spanstyle=' font-family: monospace;'>Faust</span><span> objects by many manners. One noticeable function of this package is </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8"><span>rand()</span></a><span>. This function allows to generate a random </span><spanstyle=' font-family: monospace;'>Faust</span><span> satisfying certain constraints; the number of factors, the size of these factors, the density, the scalar type, etc.</span></div><divclass = 'S1'><span>Below are examples of (pseudo-)random generations.</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre"><span>F = matfaust.rand(10, 10, </span><spanstyle="color: rgb(170, 4, 249);">'num_factors'</span><span>, 2, </span><spanstyle="color: rgb(170, 4, 249);">'density'</span><span>, .5, </span><spanstyle="color: rgb(170, 4, 249);">'field'</span><span>, </span><spanstyle="color: rgb(170, 4, 249);">'complex'</span><span>)</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement"uid="BB23049F"data-testid="output_3"style="width: 716px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divclass="textElement eoOutputContent"data-width="686"data-height="64"data-hashorizontaloverflow="false"style="max-height: 261px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divstyle="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><spanclass="variableNameElement"style="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">F = </span></div><divstyle="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">Faust size 10x10, density 1, nnz_sum 100, 2 factor(s):
- FACTOR 2 (double) DENSE, size 16x20, density 0.5, nnz 160</div></div></div></div></div></div><divclass = 'S7'><span>G is a real </span><spanstyle=' font-family: monospace;'>Faust</span><span> (the default scalar type is double). In the </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#adf468bdd261c93f719fd2ecc8d4a4254"><span>rand()</span></a><span> call </span><spanstyle=' font-family: monospace;'>num_factors</span><span> value (</span><spanstyle=' font-family: monospace;'>[2, 5]</span><span>) defines the bounds in which we want the number of factors to be and likewise the </span><spanstyle=' font-family: monospace;'>dim_sizes</span><span> argument defines the bounds in which to randomly choose the sizes of the two dimensions of each intermediary factor composing the Faust. The sizes are chosen to keep G consistent though, this is a matrix product! </span></div><divclass = 'S1'><span>The</span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8"><span> rand()</span></a><span> function will surely be of a great help if you want to test the </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><spanstyle=' font-family: monospace;'>Faust</span></a><span> member functions. A second notebook might guide you in this road: </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html"><span>How to Manipulate a Faust</span></a><span>.</span></div><h3class = 'S2'><span>4. Other Ways of Creation</span></h3><divclass = 'S1'><span>There exist many ways to create a </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><span>Faust</span></a><span>, please look at the package documentation for more information. It would be the topic of another notebook! If you want, for example, to learn about </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><span>Faust</span></a><span> generation based on the FAµST's factorization algorithms, check this notebook: </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html"><span>Using the FAµST Factorization Wrappers</span></a><span>.</span></div><divclass = 'S1'><spanstyle=' font-weight: bold;'>Note:</span><span> this livescript was executed using the following matfaust version:</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre;"><span>matfaust.version()</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement"uid="E59BEF89"data-testid="output_5"data-width="832"data-height="20"data-hashorizontaloverflow="false"style="width: 862px; max-height: 261px;"><divclass="textElement"><div><spanclass="variableNameElement">ans = </span>'3.27.2'</div></div></div></div></div></div></div><br>
</div></div></div></div></div></div><divclass = 'S7'><span>G is a real </span><spanstyle=' font-family: monospace;'>Faust</span><span> (the default scalar type is double). In the </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#adf468bdd261c93f719fd2ecc8d4a4254"><span>rand()</span></a><span> call </span><spanstyle=' font-family: monospace;'>num_factors</span><span> value (</span><spanstyle=' font-family: monospace;'>[2, 5]</span><span>) defines the bounds in which we want the number of factors to be and likewise the </span><spanstyle=' font-family: monospace;'>dim_sizes</span><span> argument defines the bounds in which to randomly choose the sizes of the two dimensions of each intermediary factor composing the Faust. The sizes are chosen to keep G consistent though, this is a matrix product! </span></div><divclass = 'S1'><span>The</span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8"><span> rand()</span></a><span> function will surely be of a great help if you want to test the </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><spanstyle=' font-family: monospace;'>Faust</span></a><span> member functions. A second notebook might guide you in this road: </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html"><span>How to Manipulate a Faust</span></a><span>.</span></div><h3class = 'S2'><span>4. Other Ways of Creation</span></h3><divclass = 'S1'><span>There exist many ways to create a </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><span>Faust</span></a><span>, please look at the package documentation for more information. It would be the topic of another notebook! If you want, for example, to learn about </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html"><span>Faust</span></a><span> generation based on the FAµST's factorization algorithms, check this notebook: </span><ahref = "https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html"><span>Using the FAµST Factorization Wrappers</span></a><span>.</span></div><divclass = 'S1'><spanstyle=' font-weight: bold;'>Note:</span><span> this livescript was executed using the following matfaust version:</span></div><divclass="CodeBlock"><divclass="inlineWrapper outputs"><divclass = 'S8'><spanstyle="white-space: pre"><span>matfaust.version()</span></span></div><divclass = 'S6'><divclass="inlineElement eoOutputWrapper embeddedOutputsVariableStringElement"uid="DA2E8328"data-testid="output_5"style="width: 716px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divclass="textElement eoOutputContent"data-width="686"data-height="21"data-hashorizontaloverflow="false"style="max-height: 261px; white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><divstyle="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;"><spanclass="variableNameElement"style="white-space: pre; font-style: normal; color: rgb(64, 64, 64); font-size: 12px;">ans = </span>'3.38.9'</div></div></div></div></div></div>
<br>
<!--
##### SOURCE BEGIN #####
%% *How to Create a Faust*
% **
%% 1. Setting the Factors Manually
% **
%
% 1. Setting the Factors Manually
%
%
% Let's start by creating a <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html
% Faust> manually, that is factor by factor.
...
...
@@ -81,17 +88,20 @@ F = Faust(factors)
% its density, the number of nonzeros it contains (|nnz_sum|) along with all its
% factors.
%
% You can also call |<https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html#a3132f572e58e6c312d5535d0e075735e
% disp(F)>| to get all the information.
% You can also call <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html#a3132f572e58e6c312d5535d0e075735e
% |disp(F)|> to get all the information.
disp(F)
%%
% **
%% *2. Faust File Loading*
% **
% Note that when you don't need |F| anymore, you can delete it with the instruction
% |delete(F)| or |clear F|. Normally, that's the role of the garbage collector
% but it might happen that your Faust is very eager in memory and a manual deletion
% is necessary.
% *2. Faust File Loading*
%
%
% It's really handy to create a |Faust| and retrieve it from a file later.
% Let's see in the code below how to proceed.
% It's really handy to create a |Faust| and retrieve it from a file later. Let's
% see in the code below how to proceed.
%
% First save the Faust.
...
...
@@ -106,11 +116,11 @@ file_F = Faust('F.mat')
% pyfaust>, the Python wrapper. You can easily reload the |F.mat| file from pyfaust.
%
%
%% 3. Generating a Random Faust
% 3. Generating a Random Faust
%
%
% The matfaust package provides functions for generating |Faust| objects
% by many manners. One noticeable function of this package is <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8
% The matfaust package provides functions for generating |Faust| objects by
% many manners. One noticeable function of this package is <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/namespacematfaust.html#a3147203d17e3b1426ca830a6a893e3b8
% rand()>. This function allows to generate a random |Faust| satisfying certain
% constraints; the number of factors, the size of these factors, the density,
% the scalar type, etc.
...
...
@@ -119,8 +129,8 @@ file_F = Faust('F.mat')
F = matfaust.rand(10, 10, 'num_factors', 2, 'density', .5, 'field', 'complex')
%%
% F is a complex |Faust|. Its rate of nonzeros, for each factor, is about
% 0.5. Since the |fac_type| argument is not set, each factor is sparse.
% F is a complex |Faust|. Its rate of nonzeros, for each factor, is about 0.5.
% Since the |fac_type| argument is not set, each factor is sparse.
% rand()> function will surely be of a great help if you want to test the |<https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html
% Faust>| member functions. A second notebook might guide you in this road: <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html
% rand()> function will surely be of a great help if you want to test the <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html
% |Faust|> member functions. A second notebook might guide you in this road: <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/Faust_manipulation.mlx.html
% How to Manipulate a Faust>.
%% 4. Other Ways of Creation
% 4. Other Ways of Creation
% There exist many ways to create a <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html
% Faust>, please look at the package documentation for more information. It would
% be the topic of another notebook! If you want, for example, to learn about <https://faustgrp.gitlabpages.inria.fr/faust/last-doc/html/classmatfaust_1_1Faust.html
