Ocean
TestSparseMatrix.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_TEST_TESTMATH_TEST_SPARSE_MATRIX_H
9 #define META_OCEAN_TEST_TESTMATH_TEST_SPARSE_MATRIX_H
10 
12 
13 namespace Ocean
14 {
15 
16 namespace Test
17 {
18 
19 namespace TestMath
20 {
21 
22 /**
23  * This class implements a matrix test.
24  * @ingroup testmath
25  */
26 class OCEAN_TEST_MATH_EXPORT TestSparseMatrix
27 {
28  public:
29 
30  /**
31  * Tests all matrix functions.
32  * @param testDuration The number of seconds for each test, with range (0, infinity)
33  * @return True, if succeeded
34  */
35  static bool test(const double testDuration);
36 
37  /**
38  * Tests the rank function.
39  * @return True, if succeeded
40  */
41  static bool testRank();
42 
43  /**
44  * Tests the non-negative matrix factorization
45  * @return True, if succeeded
46  */
47  static bool testNonNegativeMatrixFactorization(const double testDuration, const unsigned int components = 5u);
48 };
49 
50 }
51 
52 }
53 
54 }
55 
56 #endif // META_OCEAN_TEST_TESTMATH_TEST_SPARSE_MATRIX_H
This class implements a matrix test.
Definition: TestSparseMatrix.h:27
static bool testRank()
Tests the rank function.
static bool test(const double testDuration)
Tests all matrix functions.
static bool testNonNegativeMatrixFactorization(const double testDuration, const unsigned int components=5u)
Tests the non-negative matrix factorization.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15