From 162e884d477af86c71d5ef9c93e5bc2b17b40927 Mon Sep 17 00:00:00 2001 From: Cory Date: Wed, 20 Sep 2023 16:49:55 +0200 Subject: [PATCH] Update documentation --- doc/html/bug.html | 10 +- doc/html/files.html | 1 + doc/html/globals.html | 2 +- doc/html/globals_func.html | 2 +- doc/html/jacobi_8cpp.html | 6 +- doc/html/jacobi_8hpp.html | 6 +- doc/html/jacobi_8hpp_source.html | 4 +- doc/html/matrix_8hpp.html | 2 +- doc/html/search/all_5.js | 2 +- doc/html/search/all_7.js | 3 +- doc/html/search/files_3.js | 3 +- doc/html/search/functions_3.js | 2 +- doc/html/utils_8cpp.html | 195 +++++++++++++++++++++++++++++++ doc/html/utils_8hpp.html | 2 +- doc/html/utils_8hpp_source.html | 2 +- include/jacobi.hpp | 2 +- src/jacobi.cpp | 3 +- 17 files changed, 226 insertions(+), 21 deletions(-) create mode 100644 doc/html/utils_8cpp.html diff --git a/doc/html/bug.html b/doc/html/bug.html index 69d0457..ed8264e 100644 --- a/doc/html/bug.html +++ b/doc/html/bug.html @@ -74,17 +74,19 @@ $(function() {
File jacobi.cpp
-
No known bugs
+
The eigenvalues fail the test. When comparing them to arma::eigsym there is one value that is way off when testing with a 6x6 matrix.
File jacobi.hpp
-
No known bugs
+
No known bugs
File matrix.cpp
No known bugs
File matrix.hpp
-
No known bugs
+
No known bugs
File test_suite.cpp
No known bugs
+
File utils.cpp
+
No known bugs
File utils.hpp
-
No known bugs
+
No known bugs
diff --git a/doc/html/files.html b/doc/html/files.html index 95e48a8..e4cdc2b 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -81,6 +81,7 @@ $(function() {  jacobi.cppImplementation of the jacobi rotation method  matrix.cppFunction prototypes for creating tridiagonal matrices  test_suite.cppTest suite for project 2 + utils.cppImplementation of the utils diff --git a/doc/html/globals.html b/doc/html/globals.html index fd8a470..cb7c691 100644 --- a/doc/html/globals.html +++ b/doc/html/globals.html @@ -76,7 +76,7 @@ $(function() {
  • jacobi_eigensolver() : jacobi.cpp, jacobi.hpp
  • jacobi_rotate() : jacobi.cpp, jacobi.hpp
  • max_offdiag_symmetric() : matrix.cpp, matrix.hpp
    • -
  • scientific_format() : utils.hpp
    • +
  • scientific_format() : utils.cpp, utils.hpp
    • diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html index c478873..cb63135 100644 --- a/doc/html/globals_func.html +++ b/doc/html/globals_func.html @@ -75,7 +75,7 @@ $(function() {
  • jacobi_eigensolver() : jacobi.cpp, jacobi.hpp
  • jacobi_rotate() : jacobi.cpp, jacobi.hpp
  • max_offdiag_symmetric() : matrix.cpp, matrix.hpp
    • -
  • scientific_format() : utils.hpp
    • +
  • scientific_format() : utils.cpp, utils.hpp
    • diff --git a/doc/html/jacobi_8cpp.html b/doc/html/jacobi_8cpp.html index 83662c7..60c9b48 100644 --- a/doc/html/jacobi_8cpp.html +++ b/doc/html/jacobi_8cpp.html @@ -88,6 +88,7 @@ Functions  Computes a single rotation.
      void jacobi_eigensolver (const arma::mat &A, double eps, arma::vec &eigenvalues, arma::mat &eigenvectors, const int maxiter, int &iterations, bool &converged) + Solves the eigenvalue problem using the jacobi rotation method.
     

    Detailed Description

    @@ -95,7 +96,7 @@ Functions
    Author
    Cory Alexander Balaton (coryab)
    Janita Ovidie Sandtrøen Willumsen (janitaws)
    -
    Bug:
    No known bugs
    +
    Bug:
    The eigenvalues fail the test. When comparing them to arma::eigsym there is one value that is way off when testing with a 6x6 matrix.

    Function Documentation

    ◆ jacobi_eigensolver()

    @@ -152,7 +153,8 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)
    -

    @ brief Solves the eigenvalue problem using the jacobi rotation method.

    + +

    Solves the eigenvalue problem using the jacobi rotation method.

    Description

    Parameters
    diff --git a/doc/html/jacobi_8hpp.html b/doc/html/jacobi_8hpp.html index 415964c..6952681 100644 --- a/doc/html/jacobi_8hpp.html +++ b/doc/html/jacobi_8hpp.html @@ -91,6 +91,7 @@ Functions +
     Computes a single rotation.
     
    void jacobi_eigensolver (const arma::mat &A, double eps, arma::vec &eigenvalues, arma::mat &eigenvectors, const int maxiter, int &iterations, bool &converged)
     Solves the eigenvalue problem using the jacobi rotation method.
     

    Detailed Description

    @@ -98,7 +99,7 @@ Functions
    Author
    Cory Alexander Balaton (coryab)
    Janita Ovidie Sandtrøen Willumsen (janitaws)
    -
    Bug:
    No known bugs
    +
    Bug:
    No known bugs

    Function Documentation

    ◆ jacobi_eigensolver()

    @@ -155,7 +156,8 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)
    -

    @ brief Solves the eigenvalue problem using the jacobi rotation method.

    + +

    Solves the eigenvalue problem using the jacobi rotation method.

    Description

    Parameters
    diff --git a/doc/html/jacobi_8hpp_source.html b/doc/html/jacobi_8hpp_source.html index d38153f..98710d5 100644 --- a/doc/html/jacobi_8hpp_source.html +++ b/doc/html/jacobi_8hpp_source.html @@ -93,8 +93,8 @@ $(function() {
    46 bool& converged);
    47
    48#endif
    -
    jacobi_rotate
    void jacobi_rotate(arma::mat &A, arma::mat &R, int k, int l)
    Computes a single rotation.
    Definition: jacobi.cpp:14
    -
    jacobi_eigensolver
    void jacobi_eigensolver(const arma::mat &A, double eps, arma::vec &eigenvalues, arma::mat &eigenvectors, const int maxiter, int &iterations, bool &converged)
    Definition: jacobi.cpp:53
    +
    jacobi_rotate
    void jacobi_rotate(arma::mat &A, arma::mat &R, int k, int l)
    Computes a single rotation.
    Definition: jacobi.cpp:15
    +
    jacobi_eigensolver
    void jacobi_eigensolver(const arma::mat &A, double eps, arma::vec &eigenvalues, arma::mat &eigenvectors, const int maxiter, int &iterations, bool &converged)
    Solves the eigenvalue problem using the jacobi rotation method.
    Definition: jacobi.cpp:54
    diff --git a/doc/html/matrix_8hpp.html b/doc/html/matrix_8hpp.html index dd1b9f1..e57a5cb 100644 --- a/doc/html/matrix_8hpp.html +++ b/doc/html/matrix_8hpp.html @@ -105,7 +105,7 @@ Functions
    Author
    Cory Alexander Balaton (coryab)
    Janita Ovidie Sandtrøen Willumsen (janitaws)
    -
    Bug:
    No known bugs
    +
    Bug:
    No known bugs

    Function Documentation

    ◆ create_symmetric_tridiagonal()

    diff --git a/doc/html/search/all_5.js b/doc/html/search/all_5.js index ce69a23..164239a 100644 --- a/doc/html/search/all_5.js +++ b/doc/html/search/all_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['scientific_5fformat_0',['scientific_format',['../utils_8hpp.html#adfb618b2fdff47ef30a4a2b62c04f384',1,'scientific_format(double d, int width=20, int prec=10): utils.cpp'],['../utils_8hpp.html#ad54b96a1074f9df4dc892a41d115b72d',1,'scientific_format(const std::vector< double > &v, int width=20, int prec=10): utils.cpp']]] + ['scientific_5fformat_0',['scientific_format',['../utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746',1,'scientific_format(double d, int width, int prec): utils.cpp'],['../utils_8cpp.html#a58565270b643b24e3132f38c653e0199',1,'scientific_format(const std::vector< double > &v, int width, int prec): utils.cpp'],['../utils_8hpp.html#adfb618b2fdff47ef30a4a2b62c04f384',1,'scientific_format(double d, int width=20, int prec=10): utils.cpp'],['../utils_8hpp.html#ad54b96a1074f9df4dc892a41d115b72d',1,'scientific_format(const std::vector< double > &v, int width=20, int prec=10): utils.cpp']]] ]; diff --git a/doc/html/search/all_7.js b/doc/html/search/all_7.js index 4c0b08a..cd921db 100644 --- a/doc/html/search/all_7.js +++ b/doc/html/search/all_7.js @@ -1,4 +1,5 @@ var searchData= [ - ['utils_2ehpp_0',['utils.hpp',['../utils_8hpp.html',1,'']]] + ['utils_2ecpp_0',['utils.cpp',['../utils_8cpp.html',1,'']]], + ['utils_2ehpp_1',['utils.hpp',['../utils_8hpp.html',1,'']]] ]; diff --git a/doc/html/search/files_3.js b/doc/html/search/files_3.js index 4c0b08a..cd921db 100644 --- a/doc/html/search/files_3.js +++ b/doc/html/search/files_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['utils_2ehpp_0',['utils.hpp',['../utils_8hpp.html',1,'']]] + ['utils_2ecpp_0',['utils.cpp',['../utils_8cpp.html',1,'']]], + ['utils_2ehpp_1',['utils.hpp',['../utils_8hpp.html',1,'']]] ]; diff --git a/doc/html/search/functions_3.js b/doc/html/search/functions_3.js index ce69a23..164239a 100644 --- a/doc/html/search/functions_3.js +++ b/doc/html/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['scientific_5fformat_0',['scientific_format',['../utils_8hpp.html#adfb618b2fdff47ef30a4a2b62c04f384',1,'scientific_format(double d, int width=20, int prec=10): utils.cpp'],['../utils_8hpp.html#ad54b96a1074f9df4dc892a41d115b72d',1,'scientific_format(const std::vector< double > &v, int width=20, int prec=10): utils.cpp']]] + ['scientific_5fformat_0',['scientific_format',['../utils_8cpp.html#acd2a9c7a7d5a7fe9163be8c4cc110746',1,'scientific_format(double d, int width, int prec): utils.cpp'],['../utils_8cpp.html#a58565270b643b24e3132f38c653e0199',1,'scientific_format(const std::vector< double > &v, int width, int prec): utils.cpp'],['../utils_8hpp.html#adfb618b2fdff47ef30a4a2b62c04f384',1,'scientific_format(double d, int width=20, int prec=10): utils.cpp'],['../utils_8hpp.html#ad54b96a1074f9df4dc892a41d115b72d',1,'scientific_format(const std::vector< double > &v, int width=20, int prec=10): utils.cpp']]] ]; diff --git a/doc/html/utils_8cpp.html b/doc/html/utils_8cpp.html new file mode 100644 index 0000000..f75b887 --- /dev/null +++ b/doc/html/utils_8cpp.html @@ -0,0 +1,195 @@ + + + + + + + +FYS3150: Project 2: utils.cpp File Reference + + + + + + + + + +
    +
    +
    + + + + + +
    +
    FYS3150: Project 2 +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +Functions
    +
    utils.cpp File Reference
    +
    +
    + +

    Implementation of the utils. +More...

    +
    #include "utils.hpp"
    +
    + + + + + + + +

    +Functions

    std::string scientific_format (double d, int width, int prec)
     Turns a double into a string written in scientific format.
     
    std::string scientific_format (const std::vector< double > &v, int width, int prec)
     Turns a vector of doubles into a string written in scientific format.
     
    +

    Detailed Description

    +

    Implementation of the utils.

    +
    Author
    Cory Alexander Balaton (coryab)
    +
    +Janita Ovidie Sandtrøen Willumsen (janitaws)
    +
    Bug:
    No known bugs
    +

    Function Documentation

    + +

    ◆ scientific_format() [1/2]

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    std::string scientific_format (const std::vector< double > & v,
    int width = 20,
    int prec = 10 
    )
    +
    + +

    Turns a vector of doubles into a string written in scientific format.

    +
    Parameters
    + + + + +
    vThe vector to stringify
    widthThe reserved width of the string
    precThe precision of the stringified number
    +
    +
    +
    Returns
    String
    + +
    +
    + +

    ◆ scientific_format() [2/2]

    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + +
    std::string scientific_format (double d,
    int width = 20,
    int prec = 10 
    )
    +
    + +

    Turns a double into a string written in scientific format.

    +

    Code stolen from https://github.com/anderkve/FYS3150 Header: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/include/utils.hpp Source: https://github.com/anderkve/FYS3150/blob/master/code_examples/compilation_linking/example_1/src/utils.cpp

    +
    Parameters
    + + + + +
    dThe number to stringify
    widthThe reserved width of the string
    precThe precision of the stringified number
    +
    +
    +
    Returns
    String
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.6 +
    + + diff --git a/doc/html/utils_8hpp.html b/doc/html/utils_8hpp.html index 9d189d0..56d13d9 100644 --- a/doc/html/utils_8hpp.html +++ b/doc/html/utils_8hpp.html @@ -109,7 +109,7 @@ Functions
    Author
    Cory Alexander Balaton (coryab)
    Janita Ovidie Sandtrøen Willumsen (janitaws)
    -
    Bug:
    No known bugs
    +
    Bug:
    No known bugs

    Macro Definition Documentation

    ◆ DEBUG

    diff --git a/doc/html/utils_8hpp_source.html b/doc/html/utils_8hpp_source.html index ecccde0..d4a1a11 100644 --- a/doc/html/utils_8hpp_source.html +++ b/doc/html/utils_8hpp_source.html @@ -98,7 +98,7 @@ $(function() {
    58 int prec=10);
    59
    60#endif
    -
    scientific_format
    std::string scientific_format(double d, int width=20, int prec=10)
    Turns a double into a string written in scientific format.
    Definition: utils.cpp:4
    +
    scientific_format
    std::string scientific_format(double d, int width=20, int prec=10)
    Turns a double into a string written in scientific format.
    Definition: utils.cpp:10
    diff --git a/include/jacobi.hpp b/include/jacobi.hpp index 8b7dd20..faa82ac 100644 --- a/include/jacobi.hpp +++ b/include/jacobi.hpp @@ -23,7 +23,7 @@ */ void jacobi_rotate(arma::mat& A, arma::mat& R, int k, int l); -/** @ brief Solves the eigenvalue problem using the jacobi rotation method. +/** @brief Solves the eigenvalue problem using the jacobi rotation method. * * Description * diff --git a/src/jacobi.cpp b/src/jacobi.cpp index 4c09c96..00fd9eb 100644 --- a/src/jacobi.cpp +++ b/src/jacobi.cpp @@ -3,7 +3,8 @@ * * @author Cory Alexander Balaton (coryab) * @author Janita Ovidie Sandtrøen Willumsen (janitaws) - * @bug No known bugs + * @bug The eigenvalues fail the test. When comparing them to arma::eigsym + * there is one value that is way off when testing with a 6x6 matrix. */ #include