Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
dlib
Commits
273d5943
Commit
273d5943
authored
May 01, 2021
by
Davis King
Browse files
fix comment formatting
parent
cd17f324
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
17 deletions
+17
-17
dlib/matrix/fft_size.h
dlib/matrix/fft_size.h
+17
-17
No files found.
dlib/matrix/fft_size.h
View file @
273d5943
...
@@ -13,28 +13,28 @@ namespace dlib
...
@@ -13,28 +13,28 @@ namespace dlib
{
{
/*!
/*!
WHAT THIS OBJECT REPRESENTS
WHAT THIS OBJECT REPRESENTS
This object is a container used to store the dimensions of an FFT
This object is a container used to store the dimensions of an FFT
operation. It is implemented as a stack-based container with an
operation. It is implemented as a stack-based container with an
upper bound of 5 dimensions (batch,channels,height,width,depth).
upper bound of 5 dimensions (batch,channels,height,width,depth).
All dimensions must be strictly positive.
All dimensions must be strictly positive.
The object is either default constructed, constructed with an
The object is either default constructed, constructed with an
initialiser list or with a pair of iterators
initialiser list or with a pair of iterators
If default-constructed, the object is empty and in an invalid state.
If default-constructed, the object is empty and in an invalid state.
That is, FFT functions will throw if attempted to be used with such
That is, FFT functions will throw if attempted to be used with such
an object.
an object.
If constructed with an initialiser list L, the object is properly
If constructed with an initialiser list L, the object is properly
initialised provided:
initialised provided:
- L.size() > 0 and L.size() <= 5
- L.size() > 0 and L.size() <= 5
- L contains strictly positive values
- L contains strictly positive values
If constructed with a pair of iterators, the behaviour of the
If constructed with a pair of iterators, the behaviour of the
constructor is exactly the same as if constructed with an
constructor is exactly the same as if constructed with an
initializer list spanned by those iterators.
initializer list spanned by those iterators.
Once the object is constructed, it is immutable.
Once the object is constructed, it is immutable.
!*/
!*/
public:
public:
using
container_type
=
std
::
array
<
long
,
5
>
;
using
container_type
=
std
::
array
<
long
,
5
>
;
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment