]> begriffs open source - cmsis/blob - v6.0.0/DSP/index.html
Update documentation for branch main
[cmsis] / v6.0.0 / DSP / index.html
1 <!-- HTML header for doxygen 1.9.6-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>CMSIS-DSP: CMSIS-DSP</title>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="tabs.js"></script>
13 <script type="text/javascript" src="footer.js"></script>
14 <script type="text/javascript" src="navtree.js"></script>
15 <link href="navtree.css" rel="stylesheet" type="text/css"/>
16 <script type="text/javascript" src="resize.js"></script>
17 <script type="text/javascript" src="navtreedata.js"></script>
18 <script type="text/javascript" src="navtree.js"></script>
19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
20 <script type="text/javascript" src="search/searchdata.js"></script>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
24   $(document).ready(function() { init_search(); });
25 /* @license-end */
26 </script>
27 <script type="text/javascript" src="darkmode_toggle.js"></script>
28 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
29 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
30 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
31 <link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
32 <link href="version.css" rel="stylesheet" type="text/css"/>
33 <script type="text/javascript" src="../../version.js"></script>
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 55px;">
41   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
42   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
43    <div id="projectname">CMSIS-DSP
44    </div>
45    <div id="projectbrief">CMSIS DSP Software Library</div>
46   </td>
47    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
48         <span class="left">
49           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
50           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
51                onfocus="searchBox.OnSearchFieldFocus(true)" 
52                onblur="searchBox.OnSearchFieldFocus(false)" 
53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
54           </span><span class="right">
55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
56           </span>
57         </div>
58 </td>
59   <!--END !PROJECT_NAME-->
60  </tr>
61  </tbody>
62 </table>
63 </div>
64 <!-- end header part -->
65 <div id="CMSISnav" class="tabs1">
66   <ul class="tablist">
67     <script type="text/javascript">
68       writeComponentTabs.call(this);
69     </script>
70   </ul>
71 </div>
72 <script type="text/javascript">
73   writeSubComponentTabs.call(this);
74 </script>
75 <!-- Generated by Doxygen 1.9.6 -->
76 <script type="text/javascript">
77 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
78 var searchBox = new SearchBox("searchBox", "search/",'.html');
79 /* @license-end */
80 </script>
81 </div><!-- top -->
82 <div id="side-nav" class="ui-resizable side-nav-resizable">
83   <div id="nav-tree">
84     <div id="nav-tree-contents">
85       <div id="nav-sync" class="sync"></div>
86     </div>
87   </div>
88   <div id="splitbar" style="-moz-user-select:none;" 
89        class="ui-resizable-handle">
90   </div>
91 </div>
92 <script type="text/javascript">
93 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
94 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
95 /* @license-end */
96 </script>
97 <div id="doc-content">
98 <!-- window showing the filter options -->
99 <div id="MSearchSelectWindow"
100      onmouseover="return searchBox.OnSearchSelectShow()"
101      onmouseout="return searchBox.OnSearchSelectHide()"
102      onkeydown="return searchBox.OnSearchSelectKey(event)">
103 </div>
104
105 <!-- iframe showing the search results (closed by default) -->
106 <div id="MSearchResultsWindow">
107 <div id="MSearchResults">
108 <div class="SRPage">
109 <div id="SRIndex">
110 <div id="SRResults"></div>
111 <div class="SRStatus" id="Loading">Loading...</div>
112 <div class="SRStatus" id="Searching">Searching...</div>
113 <div class="SRStatus" id="NoMatches">No Matches</div>
114 </div>
115 </div>
116 </div>
117 </div>
118
119 <div><div class="header">
120   <div class="headertitle"><div class="title">CMSIS-DSP </div></div>
121 </div><!--header-->
122 <div class="contents">
123 <div class="textblock"><p><a class="anchor" id="mainpage"></a> <b>CMSIS-DSP</b> is an open-source software library that implements common compute processing functions optimized for use on Arm Cortex-M and Cortex-A processors. The library covers such compute categories as (list not exhaustive):</p>
124 <ul>
125 <li>Basic mathematics (real, complex, quaternion, linear algebra, fast math functions)</li>
126 <li>DSP (filtering)</li>
127 <li>Transforms (FFT, MFCC, DCT)</li>
128 <li>Statistics</li>
129 <li>Classical ML (Support Vector Machine, Distance functions for clustering, ...)</li>
130 </ul>
131 <h1><a class="anchor" id="autotoc_md0"></a>
132 Access to CMSIS-DSP</h1>
133 <p>CMSIS-DSP is actively maintained in a GitHub repository and is released as a standalone package in the CMSIS-Pack format.</p>
134 <ul>
135 <li><a href="https://github.com/ARM-software/CMSIS-DSP"><b>CMSIS-DSP GitHub Repo</b></a> provides the full source code of CMSIS-DSP functions.</li>
136 <li><a href="https://arm-software.github.io/CMSIS-DSP/latest/"><b>CMSIS-DSP Documentation</b></a> explains how to use the library and describes the implemented functions in details.</li>
137 <li><a href="https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/"><b>CMSIS-DSP Pack</b></a> delivers CMSIS-DSP components and examples in <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">CMSIS-Pack format</a>.</li>
138 </ul>
139 <h1><a class="anchor" id="autotoc_md1"></a>
140 Key Features and Benefits</h1>
141 <ul>
142 <li>CMSIS-DSP covers a broad set of compute functions common for use in embedded systems.</li>
143 <li>Supports operations on 8-bit integers, 16-bit integers, 32-bit integer and 32-bit floating-point values.</li>
144 <li>Provides vectorized versions of most algorthms for <a href="https://developer.arm.com/Architectures/Helium">Arm Helium Technology</a> and of most f32 algorithms for <a href="https://developer.arm.com/Architectures/Neon">Arm Neon Technology</a>.</li>
145 <li>Includes test framework.</li>
146 <li>Provides examples demonstating how to use the library functions. </li>
147 </ul>
148 </div></div><!-- PageDoc -->
149 </div><!-- contents -->
150 </div><!-- doc-content -->
151 <!-- start footer part -->
152 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
153   <ul>
154     <li class="footer">
155       <script type="text/javascript">
156         <!--
157         writeFooter.call(this);
158         //-->
159       </script> 
160     </li>
161   </ul>
162 </div>
163 </body>
164 </html>