Skip to content

Commit 7e50773

Browse files
committed
update documentation
1 parent 4fb3e3b commit 7e50773

File tree

649 files changed

+46249
-30361
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

649 files changed

+46249
-30361
lines changed

annotated.html

Lines changed: 77 additions & 75 deletions
Large diffs are not rendered by default.

annotated_dup.js

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
11
var annotated_dup =
22
[
3-
[ "LatticeTester", "d8/d74/namespaceLatticeTester.html", "d8/d74/namespaceLatticeTester" ],
4-
[ "NTL", "d2/d5a/namespaceNTL.html", "d2/d5a/namespaceNTL" ]
3+
[ "LatticeTester", "d8/d74/namespaceLatticeTester.html", [
4+
[ "CoordinateSets", "d0/d6f/namespaceLatticeTester_1_1CoordinateSets.html", [
5+
[ "AddCoordinate", "d7/d31/classLatticeTester_1_1CoordinateSets_1_1AddCoordinate.html", "d7/d31/classLatticeTester_1_1CoordinateSets_1_1AddCoordinate" ],
6+
[ "FromRanges", "d8/d34/classLatticeTester_1_1CoordinateSets_1_1FromRanges.html", "d8/d34/classLatticeTester_1_1CoordinateSets_1_1FromRanges" ],
7+
[ "Subsets", "d8/d6d/classLatticeTester_1_1CoordinateSets_1_1Subsets.html", "d8/d6d/classLatticeTester_1_1CoordinateSets_1_1Subsets" ]
8+
] ],
9+
[ "Chrono", "d9/d32/classLatticeTester_1_1Chrono.html", "d9/d32/classLatticeTester_1_1Chrono" ],
10+
[ "Coordinates", "d9/dd3/classLatticeTester_1_1Coordinates.html", "d9/dd3/classLatticeTester_1_1Coordinates" ],
11+
[ "FigureOfMeritDualM", "d4/ddf/classLatticeTester_1_1FigureOfMeritDualM.html", "d4/ddf/classLatticeTester_1_1FigureOfMeritDualM" ],
12+
[ "FigureOfMeritM", "d7/dca/classLatticeTester_1_1FigureOfMeritM.html", "d7/dca/classLatticeTester_1_1FigureOfMeritM" ],
13+
[ "IntLattice", "d6/dc0/classLatticeTester_1_1IntLattice.html", "d6/dc0/classLatticeTester_1_1IntLattice" ],
14+
[ "IntLatticeExt", "d8/d6c/classLatticeTester_1_1IntLatticeExt.html", "d8/d6c/classLatticeTester_1_1IntLatticeExt" ],
15+
[ "MRGLattice", "d9/d4e/classLatticeTester_1_1MRGLattice.html", "d9/d4e/classLatticeTester_1_1MRGLattice" ],
16+
[ "NormaBestLat", "d1/d24/classLatticeTester_1_1NormaBestLat.html", "d1/d24/classLatticeTester_1_1NormaBestLat" ],
17+
[ "NormaBestUpBound", "d2/d61/classLatticeTester_1_1NormaBestUpBound.html", "d2/d61/classLatticeTester_1_1NormaBestUpBound" ],
18+
[ "NormaLaminated", "dd/d0f/classLatticeTester_1_1NormaLaminated.html", "dd/d0f/classLatticeTester_1_1NormaLaminated" ],
19+
[ "Normalizer", "d0/dc8/classLatticeTester_1_1Normalizer.html", "d0/dc8/classLatticeTester_1_1Normalizer" ],
20+
[ "NormaMinkHlaw", "df/d78/classLatticeTester_1_1NormaMinkHlaw.html", "df/d78/classLatticeTester_1_1NormaMinkHlaw" ],
21+
[ "NormaPalpha", "d8/d6e/classLatticeTester_1_1NormaPalpha.html", "d8/d6e/classLatticeTester_1_1NormaPalpha" ],
22+
[ "NormaRogers", "d1/d30/classLatticeTester_1_1NormaRogers.html", "d1/d30/classLatticeTester_1_1NormaRogers" ],
23+
[ "Rank1Lattice", "de/dfe/classLatticeTester_1_1Rank1Lattice.html", "de/dfe/classLatticeTester_1_1Rank1Lattice" ],
24+
[ "ReducerBB", "d0/dea/classLatticeTester_1_1ReducerBB.html", "d0/dea/classLatticeTester_1_1ReducerBB" ],
25+
[ "Weights", "db/d40/classLatticeTester_1_1Weights.html", "db/d40/classLatticeTester_1_1Weights" ],
26+
[ "WeightsOrderDependent", "dd/d7f/classLatticeTester_1_1WeightsOrderDependent.html", "dd/d7f/classLatticeTester_1_1WeightsOrderDependent" ],
27+
[ "WeightsPOD", "d8/d0e/classLatticeTester_1_1WeightsPOD.html", "d8/d0e/classLatticeTester_1_1WeightsPOD" ],
28+
[ "WeightsProduct", "d1/d8a/classLatticeTester_1_1WeightsProduct.html", "d1/d8a/classLatticeTester_1_1WeightsProduct" ],
29+
[ "WeightsProjectionDependent", "d2/d23/classLatticeTester_1_1WeightsProjectionDependent.html", "d2/d23/classLatticeTester_1_1WeightsProjectionDependent" ],
30+
[ "WeightsUniform", "dd/d8f/classLatticeTester_1_1WeightsUniform.html", "dd/d8f/classLatticeTester_1_1WeightsUniform" ]
31+
] ]
532
];

bc_sd.png

635 Bytes
Loading

bdwn.png

-147 Bytes
Binary file not shown.

classes.html

Lines changed: 76 additions & 70 deletions
Large diffs are not rendered by default.

clipboard.js

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
3+
The code below is based on the Doxygen Awesome project, see
4+
https://github.com/jothepro/doxygen-awesome-css
5+
6+
MIT License
7+
8+
Copyright (c) 2021 - 2022 jothepro
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
28+
*/
29+
30+
let clipboard_title = "Copy to clipboard"
31+
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32+
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
33+
let clipboard_successDuration = 1000
34+
35+
$(function() {
36+
if(navigator.clipboard) {
37+
const fragments = document.getElementsByClassName("fragment")
38+
for(const fragment of fragments) {
39+
const clipboard_div = document.createElement("div")
40+
clipboard_div.classList.add("clipboard")
41+
clipboard_div.innerHTML = clipboard_icon
42+
clipboard_div.title = clipboard_title
43+
$(clipboard_div).click(function() {
44+
const content = this.parentNode.cloneNode(true)
45+
// filter out line number and folded fragments from file listings
46+
content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
47+
let text = content.textContent
48+
// remove trailing newlines and trailing spaces from empty lines
49+
text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
50+
navigator.clipboard.writeText(text);
51+
this.classList.add("success")
52+
this.innerHTML = clipboard_successIcon
53+
window.setTimeout(() => { // switch back to normal icon after timeout
54+
this.classList.remove("success")
55+
this.innerHTML = clipboard_icon
56+
}, clipboard_successDuration);
57+
})
58+
fragment.insertBefore(clipboard_div, fragment.firstChild)
59+
}
60+
}
61+
})

cookie.js

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*!
2+
Cookie helper functions
3+
Copyright (c) 2023 Dimitri van Heesch
4+
Released under MIT license.
5+
*/
6+
let Cookie = {
7+
cookie_namespace: 'doxygen_',
8+
9+
readSetting(cookie,defVal) {
10+
if (window.chrome) {
11+
const val = localStorage.getItem(this.cookie_namespace+cookie) ||
12+
sessionStorage.getItem(this.cookie_namespace+cookie);
13+
if (val) return val;
14+
} else {
15+
let myCookie = this.cookie_namespace+cookie+"=";
16+
if (document.cookie) {
17+
const index = document.cookie.indexOf(myCookie);
18+
if (index != -1) {
19+
const valStart = index + myCookie.length;
20+
let valEnd = document.cookie.indexOf(";", valStart);
21+
if (valEnd == -1) {
22+
valEnd = document.cookie.length;
23+
}
24+
return document.cookie.substring(valStart, valEnd);
25+
}
26+
}
27+
}
28+
return defVal;
29+
},
30+
31+
writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
32+
if (window.chrome) {
33+
if (days==0) {
34+
sessionStorage.setItem(this.cookie_namespace+cookie,val);
35+
} else {
36+
localStorage.setItem(this.cookie_namespace+cookie,val);
37+
}
38+
} else {
39+
let date = new Date();
40+
date.setTime(date.getTime()+(days*24*60*60*1000));
41+
const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
42+
document.cookie = this.cookie_namespace + cookie + "=" +
43+
val + "; SameSite=Lax;" + expiration + "path=/";
44+
}
45+
},
46+
47+
eraseSetting(cookie) {
48+
if (window.chrome) {
49+
if (localStorage.getItem(this.cookie_namespace+cookie)) {
50+
localStorage.removeItem(this.cookie_namespace+cookie);
51+
} else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
52+
sessionStorage.removeItem(this.cookie_namespace+cookie);
53+
}
54+
} else {
55+
this.writeSetting(cookie,'',-1);
56+
}
57+
},
58+
}

0 commit comments

Comments
 (0)