Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jewettaij committed Sep 5, 2020
1 parent 2f55b13 commit 008fa41
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jacobi_pd
## Description

This repository contains a small C++
[header file](include/jacobi.hpp)
[header file](include/jacobi_pd.hpp)
that implements the
[Jacobi eigenvalue algorithm](https://en.wikipedia.org/wiki/Jacobi_eigenvalue_algorithm).
It is [free of copyright](https://creativecommons.org/publicdomain/zero/1.0/).
Expand Down Expand Up @@ -46,7 +46,7 @@ No lines of code were borrowed or adapted from other sources.
*Caveats:* The code in this repository does not run in parallel,
and only works on dense square real symmetric matrices.
However it is reasonably
[short, simple](include/jacobi.hpp),
[short, simple](include/jacobi_pd.hpp),
[fast](benchmarks/README.md) and
[reliable](.travis.yml).
You can do anything you like with this code.
Expand All @@ -55,8 +55,8 @@ You can do anything you like with this code.
## Example usage

```cpp
#include "jacobi.hpp"
using namespace jacobi_public_domain;
#include "jacobi_pd.hpp"
using namespace jacobi_pd;

// ...

Expand Down
3 changes: 2 additions & 1 deletion include/jacobi_pd.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
#ifndef _JACOBI_HPP
#define _JACOBI_HPP

#include <algorithm>
#include <cmath>
#include <cassert>
#include "matrix_alloc.hpp"

namespace jacobi_public_domain {
namespace jacobi_pd {

using namespace matrix_alloc;

Expand Down
4 changes: 2 additions & 2 deletions tests/test_jacobi.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#include <vector>
#include <array>
#include "matrix_alloc.hpp"
#include "jacobi.hpp"
#include "jacobi_pd.hpp"

using std::cout;
using std::cerr;
Expand All @@ -20,7 +20,7 @@ using std::setprecision;
using std::vector;
using std::array;
using namespace matrix_alloc;
using namespace jacobi_public_domain;
using namespace jacobi_pd;


// This code works with various types of C++ matrices (for example,
Expand Down

0 comments on commit 008fa41

Please sign in to comment.