From d68616cbeb94b464618adf5181d60c1ddd13f037 Mon Sep 17 00:00:00 2001
From: Pascal Engeler <engelerp@phys.ethz.ch>
Date: Tue, 21 Jan 2020 16:22:36 +0100
Subject: [PATCH] case change
---
README.md | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 199910a..31240fb 100644
--- a/README.md
+++ b/README.md
@@ -80,7 +80,7 @@ where it improves legibility. Consult the source files for more information.
#### `Vec2` (vec2.hpp), 2-vector utility class
1. Template arguments
- `value_t`: type of vector entries
-2. Explicit Constructors
+2. Explicit constructors
- `Vec2(const value_t, const value_t)`
- `Vec2(const Vec2&)`
- `Vec2()`
@@ -120,10 +120,12 @@ where it improves legibility. Consult the source files for more information.
- All versions of `op=` of the above
- `[]` with `std::size_t`
- `<<` with `std::ostream`
+4. Dependencies
+5. Dependents
<a name="diagonalizer"></a>
#### `Diagonalizer` (diagonalizer.hpp), class to diagonalize symmetric Matrices
-1. Explicit Constructors
+1. Explicit constructors
- `Diagonalizer()`
2. Member functions
- `std::vector<double> ev(std::vector<double> mat, size_t N)`
@@ -149,7 +151,7 @@ where it improves legibility. Consult the source files for more information.
- `params_t`: Drum parameters container type
- `vars_t`: Drum variables container type
- `sbuffer_t`: Stepper buffer container type
-2. Explicit Constructors
+2. Explicit constructors
- `Drum(const params_t&)`
- `Drum() = delete`
- `Drum(const Drum&)`
@@ -194,7 +196,7 @@ be trivial.
- `params_t`: Drum parameters type
- `vars_t`: Drum variables type
- `buffer_t`: Stepper buffer type
-2. Explicit Constructors
+2. Explicit constructors
- `Force()`
3. Virtual functions
- `value_t operator()(drum_t drum, drum_t n1, drum_t n2, drum_t n3, value_t time)`
@@ -214,7 +216,7 @@ showcases how a real force functional could be written.
1. Template arguments
- `value_t`: Scalar type
- `drum_t`: Drum type
-2. Explicit Constructors
+2. Explicit constructors
- `Driver()`
3. Virtual functions
- `void precompute(value_t t_end, value_t dt, std::vector<drum_t> drum_vec)`
@@ -241,7 +243,7 @@ Note that an rk4 scheme advances time in steps of `dt/2`.
1. Template arguments
- `value_t`: Scalar type
- `drum_t`: Drum type
-2. Explicit Constructors
+2. Explicit constructors
- `Coupler()`
3. Virtual functions
- `void precompute(value_t t_end, value_t dt, std::vector<drum_t> drum_vec)`
@@ -270,7 +272,7 @@ Note that an rk4 scheme advances time in steps of `dt/2`.
- `params_t`: Drum parameters type
- `vars_t`: Drum variables type
- `sbuffer_t`: Stepper buffer type
-2. Explicit Constructors
+2. Explicit constructors
- `LatticeGenerator()`
3. Virtual functions
- `std::pair<std::vector<drum_t>, std::vector<int> > operator()(params_t)`
@@ -324,7 +326,7 @@ if one uses the couplings of the neighbours instead of the considered drum.
- `params_t`: Drum parameters type
- `vars_t`: Drum variables type
- `drum_t`: Drum type
-2. Explicit Constructors
+2. Explicit constructors
- `MatrixElementCalculator()`
3. Virtual functions
- `value_t operator()(size_t index, std::vector<drum_t>)`
@@ -361,7 +363,7 @@ the individual functions correctly to accomodate the correct neighbours.
- `vars_t`: Drum variables container type
- `buffer_t`: Stepper buffer container type
- `force_t`: Force functional type
-2. Explicit Constructors
+2. Explicit constructors
- `Rk4Stepper()`
3. Member functions
- `void step_1(force_t, std::vector<drum_t>, std::vector<std::vector<int> >, value_t dt, value_t time)`
@@ -376,7 +378,7 @@ the individual functions correctly to accomodate the correct neighbours.
1. Template arguments
- `coupler_t`: Coupler type
- `driver_t`: Driver type
-2. Explicit Constructors
+2. Explicit constructors
- `SystemParameters(coupler_t, driver_t, std::vector<std::vector<int> >)`
3. Public data members
- `coupler`: The coupler_t object of the system
@@ -388,7 +390,7 @@ the individual functions correctly to accomodate the correct neighbours.
1. Template arguments
- `value_t`: Scalar type
- `drum_t`: Drum type
-2. Explicit Constructors
+2. Explicit constructors
- `Grabber(const size_t grab_every, const std::string params_file, const std::string adjacency_file, const std::string dynamic_file)`
- `grab_every`: stride between data grabs
- `params_file`: file for parameters saving
--
GitLab