From c7268fe5362a923d2667d92831fa3e05da7e1ee4 Mon Sep 17 00:00:00 2001 From: Pierre CHATAIGNER Date: Sun, 25 Feb 2024 13:06:11 +0100 Subject: [PATCH 01/45] nombres rationnels --- makefile | 69 ++++++++++++++++++++++ src/NR.cpp | 159 +++++++++++++++++++++++++++++++++++++++++++++++++++ src/NR.h | 36 +++++++++++- src/main.cpp | 6 +- 4 files changed, 265 insertions(+), 5 deletions(-) create mode 100644 makefile create mode 100644 src/NR.cpp diff --git a/makefile b/makefile new file mode 100644 index 0000000..33e0562 --- /dev/null +++ b/makefile @@ -0,0 +1,69 @@ +# this is the build file for project +# it is autogenerated by the xmake build system. +# do not edit by hand. + +ifneq ($(VERBOSE),1) +VV=@ +endif + +AS=/Library/Developer/CommandLineTools/usr/bin/clang +MXX=/Library/Developer/CommandLineTools/usr/bin/clang +FC=/usr/local/bin/gfortran +CXX=/Library/Developer/CommandLineTools/usr/bin/clang +CU=/usr/bin/clang +MM=/Library/Developer/CommandLineTools/usr/bin/clang +SC=/Library/Developer/CommandLineTools/usr/bin/swiftc +CC=/Library/Developer/CommandLineTools/usr/bin/clang + +AR=/Library/Developer/CommandLineTools/usr/bin/ar +FCSH=/usr/local/bin/gfortran +SH=/Library/Developer/CommandLineTools/usr/bin/clang++ +SCSH=/Library/Developer/CommandLineTools/usr/bin/swiftc +FCLD=/usr/local/bin/gfortran +LD=/Library/Developer/CommandLineTools/usr/bin/clang++ +SCLD=/Library/Developer/CommandLineTools/usr/bin/swiftc + +Pivot_LD=/Library/Developer/CommandLineTools/usr/bin/clang++ +Pivot_CXX=/Library/Developer/CommandLineTools/usr/bin/clang +Pivot_CXX=/Library/Developer/CommandLineTools/usr/bin/clang + +Pivot_CXXFLAGS=-Qunused-arguments -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -fvisibility=hidden -fvisibility-inlines-hidden -O3 -std=c++17 -DNDEBUG +Pivot_CXXFLAGS=-Qunused-arguments -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -fvisibility=hidden -fvisibility-inlines-hidden -O3 -std=c++17 -DNDEBUG +Pivot_LDFLAGS=-isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -stdlib=libc++ -lz -Wl,-x -Wl,-dead_strip + +default: Pivot + +all: Pivot + +.PHONY: default all Pivot + +Pivot: build/macosx/x86_64/release/Pivot +build/macosx/x86_64/release/Pivot: build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o + @echo linking.release Pivot + @mkdir -p build/macosx/x86_64/release + $(VV)$(Pivot_LD) -o build/macosx/x86_64/release/Pivot build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o $(Pivot_LDFLAGS) + +build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o: src/NR.cpp + @echo compiling.release src/NR.cpp + @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src + $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o src/NR.cpp + +build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o: src/Matrix.cpp + @echo compiling.release src/Matrix.cpp + @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src + $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o src/Matrix.cpp + +build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o: src/main.cpp + @echo compiling.release src/main.cpp + @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src + $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o src/main.cpp + +clean: clean_Pivot + +clean_Pivot: + @rm -rf build/macosx/x86_64/release/Pivot + @rm -rf build/macosx/x86_64/release/Pivot.dSYM + @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o + @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o + @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o + diff --git a/src/NR.cpp b/src/NR.cpp new file mode 100644 index 0000000..d86584b --- /dev/null +++ b/src/NR.cpp @@ -0,0 +1,159 @@ +#include "NR.h" +#include + +int PGCD(int x, int y) { + if(x==0 || y==0) + return 1; + else if(x%y == 0) + return abs(y); + else + return PGCD(y, x%y); +} + +NR::NR(int numerator, int denominator) { + NRset(numerator, denominator); +} + +void NR::NRset(int numerator, int denominator) { + if(denominator > 0) + m_Numerator = numerator; + else + m_Numerator = (-1)*numerator; + if(denominator == 0) { + std::cout<<"Essaie de créer une fraction avec un dénominateur = 0, impossible"<(const NR& opNR) const { + return (m_Numerator * opNR.NRgetDen() > m_Denominator * opNR.NRgetNum()); +} + +bool NR::operator !=(const NR& opNR) const { + return (not (*this == opNR)); +} + +bool NR::operator <=(const NR& opNR) const { + return (not (*this > opNR)); +} + +bool NR::operator >=(const NR& opNR) const { + return (not (*this < opNR)); +} + +std::ostream& operator <<(std::ostream& os, const NR& opNR) { + os<>(std::istream& is, NR& opNR) { + int num, den; + std::cout<<"Numerator: "; + is>>num; + std::cout<<"Denominator: "; + is>>den; + opNR.NRset(num, den); + return is; +} + +NR NR::operator +(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.NRgetDen(); + den = m_Denominator * opNR.NRgetDen(); + num += (opNR.NRgetNum() * m_Denominator); + NR result(num, den); + return result; +} + +NR NR::operator -(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.NRgetDen(); + den = m_Denominator * opNR.NRgetDen(); + num -= (opNR.NRgetNum() * m_Denominator); + NR result(num, den); + return result; +} + +NR NR::operator *(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.NRgetNum(); + den = m_Denominator * opNR.NRgetDen(); + NR result(num, den); + return result; +} + +NR NR::operator /(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.NRgetDen(); + den = m_Denominator * opNR.NRgetNum(); + NR result(num, den); + return result; +} + +void NR::test() { + NR* frac = new NR; + NR frac2(3); + NR frac3(2,5); + int a, b; + std::cout<<"PGCD : entrez deux entiers"<>a>>b; + std::cout<>a>>b; + NR fractest(a, b); + std::cout<> "<<(fractest + frac3)<> "<<(fractest + frac3).NRgetNum()<<"/"<<(fractest + frac3).NRgetDen()<> "<NRset(2, 4); + NR anotherfrac; + std::cin>>anotherfrac; + std::cout<<"Compare "<=? "<<(fractest >= anotherfrac)<< std::endl; + std::cout<> "<> "<> "<> "<<(numNR - otherNR)<> "< + class NR { private: int m_Numerator; - int m_Denominator; + int m_Denominator; //has to be > 0, sign is carried by the numerator public: NR() : m_Numerator(0), m_Denominator(1) {} NR(int entier) : m_Numerator(entier), m_Denominator(1) {} - NR(int numerator, int denominator) : m_Numerator(numerator), m_Denominator(denominator) {} -}; \ No newline at end of file + NR(int numerator, int denominator); //check if denominator != 0 + void NRset(int numerator, int denominator); //same + + void reduceNR(); //divide by PGCD, not automatically called yet + void invertNR(); + + int NRgetNum() const; + int NRgetDen() const; + NR& operator =(const NR& opNR); + + bool operator ==(const NR& opNR) const; + bool operator <(const NR& opNR) const; + bool operator >(const NR& opNR) const; + + bool operator !=(const NR& opNR) const; + bool operator <=(const NR& opNR) const; + bool operator >=(const NR& opNR) const; + + friend std::ostream& operator <<(std::ostream& os, const NR& opNR); + friend std::istream& operator >>(std::istream& os, NR& opNR); + + NR operator +(const NR& opNR) const; + NR operator -(const NR& opNR) const; + NR operator *(const NR& opNR) const; + NR operator /(const NR& opNR) const; + + static void test(); +}; + +int PGCD(int x, int y); \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp index 1e71236..4b92d2c 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,4 +1,5 @@ #include "Matrix.h" +#include "NR.h" #include void test() { @@ -38,7 +39,8 @@ void prompt() { } int main(int argc, char** argv) { - test(); - prompt(); + //test(); + //prompt(); + NR::test(); return 0; } From ad288b366169abb16302f1656d2fd55af8b0eaf1 Mon Sep 17 00:00:00 2001 From: Julien Chataigner Date: Sun, 25 Feb 2024 13:25:04 +0100 Subject: [PATCH 02/45] test --- src/main.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main.cpp b/src/main.cpp index c77b9d1..d09c387 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -61,8 +61,8 @@ void prompt() { } int main(int argc, char** argv) { - //test(); - //prompt(); + test(); + prompt(); NR::test(); return 0; } From abd5c7ac568dfd75da66edbd823df819518e60d7 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Sun, 25 Feb 2024 20:28:01 +0100 Subject: [PATCH 03/45] refactor NR --- src/NR.cpp | 201 +++++++++++++++++++++++------------------------------ src/NR.h | 48 +++++++------ 2 files changed, 111 insertions(+), 138 deletions(-) diff --git a/src/NR.cpp b/src/NR.cpp index d86584b..b32d64e 100644 --- a/src/NR.cpp +++ b/src/NR.cpp @@ -1,159 +1,130 @@ #include "NR.h" + +#include #include int PGCD(int x, int y) { - if(x==0 || y==0) - return 1; - else if(x%y == 0) - return abs(y); - else - return PGCD(y, x%y); + if (x == 0 || y == 0) + return 1; + else if (x % y == 0) + return std::abs(y); + else + return PGCD(y, x % y); } -NR::NR(int numerator, int denominator) { - NRset(numerator, denominator); +NR::NR() : m_Numerator(0), m_Denominator(1) {} + +NR::NR(int entier) : m_Numerator(entier), m_Denominator(1) {} + +NR::NR(int numerator, int denominator) : + m_Numerator((denominator > 0) ? numerator : -numerator), m_Denominator(std::abs(denominator)) { + assert(denominator != 0); } -void NR::NRset(int numerator, int denominator) { - if(denominator > 0) - m_Numerator = numerator; - else - m_Numerator = (-1)*numerator; - if(denominator == 0) { - std::cout<<"Essaie de créer une fraction avec un dénominateur = 0, impossible"<(const NR& opNR) const { + return (m_Numerator * opNR.GetDenominator() > m_Denominator * opNR.GetNumerator()); } -bool NR::operator <(const NR& opNR) const { - return (m_Numerator * opNR.NRgetDen() < m_Denominator * opNR.NRgetNum()); +bool NR::operator!=(const NR& opNR) const { + return !(*this == opNR); } -bool NR::operator >(const NR& opNR) const { - return (m_Numerator * opNR.NRgetDen() > m_Denominator * opNR.NRgetNum()); +bool NR::operator<=(const NR& opNR) const { + return !(*this > opNR); } -bool NR::operator !=(const NR& opNR) const { - return (not (*this == opNR)); +bool NR::operator>=(const NR& opNR) const { + return !(*this < opNR); } -bool NR::operator <=(const NR& opNR) const { - return (not (*this > opNR)); +std::ostream& operator<<(std::ostream& os, const NR& opNR) { + os << opNR.GetNumerator() << "/" << opNR.GetDenominator(); + return os; } -bool NR::operator >=(const NR& opNR) const { - return (not (*this < opNR)); +std::istream& operator>>(std::istream& is, NR& opNR) { + char slash; + is >> opNR.m_Numerator >> slash >> opNR.m_Denominator; + opNR.Reduce(); + return is; } -std::ostream& operator <<(std::ostream& os, const NR& opNR) { - os<>(std::istream& is, NR& opNR) { - int num, den; - std::cout<<"Numerator: "; - is>>num; - std::cout<<"Denominator: "; - is>>den; - opNR.NRset(num, den); - return is; +NR NR::operator-(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.GetDenominator(); + den = m_Denominator * opNR.GetDenominator(); + num -= (opNR.GetNumerator() * m_Denominator); + NR result(num, den); + return result; } -NR NR::operator +(const NR& opNR) const { - int num, den; - num = m_Numerator * opNR.NRgetDen(); - den = m_Denominator * opNR.NRgetDen(); - num += (opNR.NRgetNum() * m_Denominator); - NR result(num, den); - return result; +NR NR::operator*(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.GetNumerator(); + den = m_Denominator * opNR.GetDenominator(); + NR result(num, den); + return result; } -NR NR::operator -(const NR& opNR) const { - int num, den; - num = m_Numerator * opNR.NRgetDen(); - den = m_Denominator * opNR.NRgetDen(); - num -= (opNR.NRgetNum() * m_Denominator); - NR result(num, den); - return result; +NR NR::operator/(const NR& opNR) const { + int num, den; + num = m_Numerator * opNR.GetDenominator(); + den = m_Denominator * opNR.GetNumerator(); + NR result(num, den); + return result; } -NR NR::operator *(const NR& opNR) const { - int num, den; - num = m_Numerator * opNR.NRgetNum(); - den = m_Denominator * opNR.NRgetDen(); - NR result(num, den); - return result; +NR& NR::operator+=(const NR& opNR) { + *this = *this + opNR; + return *this; } -NR NR::operator /(const NR& opNR) const { - int num, den; - num = m_Numerator * opNR.NRgetDen(); - den = m_Denominator * opNR.NRgetNum(); - NR result(num, den); - return result; +NR& NR::operator-=(const NR& opNR) { + *this = *this - opNR; + return *this; } -void NR::test() { - NR* frac = new NR; - NR frac2(3); - NR frac3(2,5); - int a, b; - std::cout<<"PGCD : entrez deux entiers"<>a>>b; - std::cout<>a>>b; - NR fractest(a, b); - std::cout<> "<<(fractest + frac3)<> "<<(fractest + frac3).NRgetNum()<<"/"<<(fractest + frac3).NRgetDen()<> "<NRset(2, 4); - NR anotherfrac; - std::cin>>anotherfrac; - std::cout<<"Compare "<=? "<<(fractest >= anotherfrac)<< std::endl; - std::cout<> "<> "<> "<> "<<(numNR - otherNR)<> "< 0, sign is carried by the numerator + int m_Denominator; // has to be > 0, sign is carried by the numerator public: - NR() : m_Numerator(0), m_Denominator(1) {} + NR(); + NR(int entier); + NR(int numerator, int denominator); // check if denominator != 0 - NR(int entier) : m_Numerator(entier), m_Denominator(1) {} - NR(int numerator, int denominator); //check if denominator != 0 - void NRset(int numerator, int denominator); //same + int GetNumerator() const; + int GetDenominator() const; - void reduceNR(); //divide by PGCD, not automatically called yet - void invertNR(); + bool operator==(const NR& opNR) const; + bool operator<(const NR& opNR) const; + bool operator>(const NR& opNR) const; - int NRgetNum() const; - int NRgetDen() const; - NR& operator =(const NR& opNR); + bool operator!=(const NR& opNR) const; + bool operator<=(const NR& opNR) const; + bool operator>=(const NR& opNR) const; - bool operator ==(const NR& opNR) const; - bool operator <(const NR& opNR) const; - bool operator >(const NR& opNR) const; + NR operator+(const NR& opNR) const; + NR operator-(const NR& opNR) const; + NR operator*(const NR& opNR) const; + NR operator/(const NR& opNR) const; - bool operator !=(const NR& opNR) const; - bool operator <=(const NR& opNR) const; - bool operator >=(const NR& opNR) const; + NR& operator+=(const NR& opNR); + NR& operator-=(const NR& opNR); + NR& operator*=(const NR& opNR); + NR& operator/=(const NR& opNR); - friend std::ostream& operator <<(std::ostream& os, const NR& opNR); - friend std::istream& operator >>(std::istream& os, NR& opNR); + void Invert(); - NR operator +(const NR& opNR) const; - NR operator -(const NR& opNR) const; - NR operator *(const NR& opNR) const; - NR operator /(const NR& opNR) const; + friend std::ostream& operator<<(std::ostream& os, const NR& opNR); + friend std::istream& operator>>(std::istream& os, NR& opNR); - static void test(); + private: + void Reduce(); }; int PGCD(int x, int y); From b8ee47e2677207e5eeea86a014c058aca788bdf4 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Sun, 25 Feb 2024 20:29:10 +0100 Subject: [PATCH 04/45] add very basic NR test --- test/test_rational.cpp | 53 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 test/test_rational.cpp diff --git a/test/test_rational.cpp b/test/test_rational.cpp new file mode 100644 index 0000000..53d1674 --- /dev/null +++ b/test/test_rational.cpp @@ -0,0 +1,53 @@ +#include "NR.h" + +#include + +static void test() { + /*NR* frac = new NR; + NR frac2(3); + NR frac3(2, 5); + int a, b; + std::cout << "PGCD : entrez deux entiers" << std::endl; + std::cin >> a >> b; + std::cout << PGCD(a, b) << std::endl; + std::cout << "frac : entrez deux entiers" << std::endl; + std::cin >> a >> b; + NR fractest(a, b); + std::cout << fractest << " + " << frac3 << " = " << std::endl; + std::cout << ">> " << (fractest + frac3) << std::endl; + std::cout << ">> " << (fractest + frac3).GetNumerator() << "/" << (fractest + frac3).GetDenominator() << std::endl; + fractest = fractest + frac3; + std::cout << ">> " << fractest << std::endl; + // frac->NRset(2, 4); + NR anotherfrac; + std::cin >> anotherfrac; + std::cout << "Compare " << fractest << " and " << anotherfrac << " : ==? " << (fractest == anotherfrac) << " =? " << (fractest >= anotherfrac) << std::endl; + std::cout << anotherfrac << " - " << *frac << " = " << anotherfrac - *frac << std::endl; + std::cout << anotherfrac << " * " << *frac << " = " << std::endl << ">> " << anotherfrac * *frac << std::endl; + fractest = anotherfrac * *frac; + std::cout << ">> " << fractest << std::endl; + fractest.Reduce(); + std::cout << ">> " << fractest << std::endl; + std::cout << anotherfrac << " / " << frac2 << " = " << anotherfrac / frac2 << std::endl; + NR numNR(2, 4); + NR otherNR(3, 1); + std::cout << numNR << " - " << otherNR << " = " << std::endl; + NR subNR = numNR - otherNR; + std::cout << ">> " << (numNR - otherNR) << std::endl << ">> " << subNR << std::endl; + delete frac;*/ + + NR frac1 {2}; + NR frac2 {1}; + + assert(frac1 != frac2); + + frac2 *= 2; + + assert(frac1 == frac2); +} + +int main(int argc, char** argv) { + test(); + return 0; +} \ No newline at end of file From ff79704293e0fccec858e20917308ec779a16b64 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Sun, 25 Feb 2024 21:16:07 +0100 Subject: [PATCH 05/45] fix main --- src/main.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main.cpp b/src/main.cpp index d09c387..fc483bf 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -63,6 +63,5 @@ void prompt() { int main(int argc, char** argv) { test(); prompt(); - NR::test(); return 0; } From b7bf6534312de0d9b60c4323881fb299b00283c0 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Sun, 25 Feb 2024 21:18:30 +0100 Subject: [PATCH 06/45] remove makefile --- makefile | 69 -------------------------------------------------------- 1 file changed, 69 deletions(-) delete mode 100644 makefile diff --git a/makefile b/makefile deleted file mode 100644 index 33e0562..0000000 --- a/makefile +++ /dev/null @@ -1,69 +0,0 @@ -# this is the build file for project -# it is autogenerated by the xmake build system. -# do not edit by hand. - -ifneq ($(VERBOSE),1) -VV=@ -endif - -AS=/Library/Developer/CommandLineTools/usr/bin/clang -MXX=/Library/Developer/CommandLineTools/usr/bin/clang -FC=/usr/local/bin/gfortran -CXX=/Library/Developer/CommandLineTools/usr/bin/clang -CU=/usr/bin/clang -MM=/Library/Developer/CommandLineTools/usr/bin/clang -SC=/Library/Developer/CommandLineTools/usr/bin/swiftc -CC=/Library/Developer/CommandLineTools/usr/bin/clang - -AR=/Library/Developer/CommandLineTools/usr/bin/ar -FCSH=/usr/local/bin/gfortran -SH=/Library/Developer/CommandLineTools/usr/bin/clang++ -SCSH=/Library/Developer/CommandLineTools/usr/bin/swiftc -FCLD=/usr/local/bin/gfortran -LD=/Library/Developer/CommandLineTools/usr/bin/clang++ -SCLD=/Library/Developer/CommandLineTools/usr/bin/swiftc - -Pivot_LD=/Library/Developer/CommandLineTools/usr/bin/clang++ -Pivot_CXX=/Library/Developer/CommandLineTools/usr/bin/clang -Pivot_CXX=/Library/Developer/CommandLineTools/usr/bin/clang - -Pivot_CXXFLAGS=-Qunused-arguments -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -fvisibility=hidden -fvisibility-inlines-hidden -O3 -std=c++17 -DNDEBUG -Pivot_CXXFLAGS=-Qunused-arguments -isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -fvisibility=hidden -fvisibility-inlines-hidden -O3 -std=c++17 -DNDEBUG -Pivot_LDFLAGS=-isysroot /Library/Developer/CommandLineTools/SDKs/MacOSX10.14.sdk -stdlib=libc++ -lz -Wl,-x -Wl,-dead_strip - -default: Pivot - -all: Pivot - -.PHONY: default all Pivot - -Pivot: build/macosx/x86_64/release/Pivot -build/macosx/x86_64/release/Pivot: build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o - @echo linking.release Pivot - @mkdir -p build/macosx/x86_64/release - $(VV)$(Pivot_LD) -o build/macosx/x86_64/release/Pivot build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o $(Pivot_LDFLAGS) - -build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o: src/NR.cpp - @echo compiling.release src/NR.cpp - @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src - $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o src/NR.cpp - -build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o: src/Matrix.cpp - @echo compiling.release src/Matrix.cpp - @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src - $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o src/Matrix.cpp - -build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o: src/main.cpp - @echo compiling.release src/main.cpp - @mkdir -p build/.objs/Pivot/macosx/x86_64/release/src - $(VV)$(Pivot_CXX) -c $(Pivot_CXXFLAGS) -o build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o src/main.cpp - -clean: clean_Pivot - -clean_Pivot: - @rm -rf build/macosx/x86_64/release/Pivot - @rm -rf build/macosx/x86_64/release/Pivot.dSYM - @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/NR.cpp.o - @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/Matrix.cpp.o - @rm -rf build/.objs/Pivot/macosx/x86_64/release/src/main.cpp.o - From 81e82b27a493ee51bfe7b8bdeac6dd8f639e7e01 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Sun, 25 Feb 2024 21:27:09 +0100 Subject: [PATCH 07/45] update Readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa2b67b..39971e0 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,20 @@ # Cahier des charges ![imagecdc](PeiP2_MAM-INFO_projet_02.jpg) -# Build +# Build ⚙️ ``` xmake ``` -# Run +# Run 🏃 ``` xmake run +``` + +# Test 🛠 + +``` +xmake test ``` \ No newline at end of file From edb79f725c4d35bc0e32d677a7aea529196af902 Mon Sep 17 00:00:00 2001 From: Julien Chataigner Date: Tue, 27 Feb 2024 16:12:56 +0100 Subject: [PATCH 08/45] ajout de tests --- matricies/test/matrice2.test | 14 ++++++++++++++ matricies/test/matrice3.test | 16 ++++++++++++++++ matricies/test/matrice4.test | 17 +++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 matricies/test/matrice2.test create mode 100644 matricies/test/matrice3.test create mode 100644 matricies/test/matrice4.test diff --git a/matricies/test/matrice2.test b/matricies/test/matrice2.test new file mode 100644 index 0000000..0bb7abd --- /dev/null +++ b/matricies/test/matrice2.test @@ -0,0 +1,14 @@ +3 3 +1 0 1 +0 1 3 +0 4 4 + +3 3 +1 0 0 +0 1 0 +0 0 1 + +3 1 +0 +0 +0 \ No newline at end of file diff --git a/matricies/test/matrice3.test b/matricies/test/matrice3.test new file mode 100644 index 0000000..e20994e --- /dev/null +++ b/matricies/test/matrice3.test @@ -0,0 +1,16 @@ +4 3 +1 -1 0 +2 1 3 +1 2 3 +2 -2 0 + +4 2 +1 0 +1 1 +0 1 +2 0 + +3 1 +1 +1 +-1 \ No newline at end of file diff --git a/matricies/test/matrice4.test b/matricies/test/matrice4.test new file mode 100644 index 0000000..cf499b8 --- /dev/null +++ b/matricies/test/matrice4.test @@ -0,0 +1,17 @@ +4 4 +5 2 3 0 +9 0 -9 0 +1 0 -1 0 +0 0 3 -3 + +4 3 +1 0 0 +0 0 9 +0 0 1 +0 -3 0 + +4 1 +1 +-4 +1 +1 \ No newline at end of file From 8d940cadf600b30cb632050a76c209b53d0209c2 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 12:07:58 +0100 Subject: [PATCH 09/45] add matrix test --- matricies/test/matrice5.test | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 matricies/test/matrice5.test diff --git a/matricies/test/matrice5.test b/matricies/test/matrice5.test new file mode 100644 index 0000000..eeed27f --- /dev/null +++ b/matricies/test/matrice5.test @@ -0,0 +1,14 @@ +5 4 +0 0 0 0 +0 0 0 0 +0 0 0 0 +0 0 0 0 +0 0 0 0 + +5 0 + +4 4 +1 0 0 0 +0 1 0 0 +0 0 1 0 +0 0 0 1 \ No newline at end of file From 10d2bb1da0b0c15273a6627d1fb95b25693222f3 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 12:13:14 +0100 Subject: [PATCH 10/45] add another test --- matricies/test/matrice6.test | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 matricies/test/matrice6.test diff --git a/matricies/test/matrice6.test b/matricies/test/matrice6.test new file mode 100644 index 0000000..8738f8e --- /dev/null +++ b/matricies/test/matrice6.test @@ -0,0 +1,19 @@ +5 4 +0 0 0 0 +0 0 0 1 +0 0 0 0 +0 0 0 0 +0 0 0 0 + +5 1 +0 +1 +0 +0 +0 + +4 3 +1 0 0 +0 1 0 +0 0 1 +0 0 0 \ No newline at end of file From 890575bc7d1cdc81c70e6f547bab99342eb0b319 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 14:01:20 +0100 Subject: [PATCH 11/45] remove useless variables --- src/Matrix.cpp | 1 - src/main.cpp | 1 - xmake.lua | 1 + 3 files changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Matrix.cpp b/src/Matrix.cpp index 596a55f..244b36c 100644 --- a/src/Matrix.cpp +++ b/src/Matrix.cpp @@ -46,7 +46,6 @@ void Matrix::Print() const { for (size_t i = 0; i < m_Raws; ++i) { std::cout << "[ "; for (size_t j = 0; j < m_Columns; ++j) { - std::size_t indice = i * m_Raws + j; std::cout << at(i, j) << " "; } std::cout << "]"; diff --git a/src/main.cpp b/src/main.cpp index fc483bf..114bb8e 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -47,7 +47,6 @@ void prompt() { std::cout << "Quelle est le nombre de colonnes de votre matrice ?" << std::endl; std::size_t colonnes; std::cin >> colonnes; - std::size_t dimension = lignes * colonnes; std::cout << "Rentrez les coefficients de la matrice" << std::endl; Matrix mat(lignes, colonnes); diff --git a/xmake.lua b/xmake.lua index 1744eb4..758fbe8 100644 --- a/xmake.lua +++ b/xmake.lua @@ -1,6 +1,7 @@ add_rules("mode.debug", "mode.release") set_languages("c++17") +set_warnings("all") -- Solver Library target("Pivot") From b9a5100cb0d7b54b35cf45dd6a6e40610a870fb2 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 14:05:12 +0100 Subject: [PATCH 12/45] fix typo --- src/Vect.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Vect.cpp b/src/Vect.cpp index e3a2368..3b3e7a7 100644 --- a/src/Vect.cpp +++ b/src/Vect.cpp @@ -33,7 +33,7 @@ bool Vect::operator==(const Vect& other) const { if (GetDimension() != other.GetDimension() || GetCardinal() != other.GetCardinal()) return false; - // on vérifie si chaque vecteur de la deuxième base appartient à la première base + // on vérifie si chaque vecteur de la deuxième base appartient à l'espace vectoriel engendré par la première base for (std::size_t i = 0; i < GetCardinal(); i++) { Vect base = *this; base.AddVector(other.m_Data.SubMatrix(0, i, GetDimension(), 1)); From d038ac588496179474d5a816f893cc3cd57fa997 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 14:48:36 +0100 Subject: [PATCH 13/45] big internal rework --- src/Gauss.cpp | 110 ++++++++++++++++++++----------------------- src/Gauss.h | 6 +++ src/IO.cpp | 101 +++++++++++++++++++++++++++++++++++++++ src/IO.h | 19 ++++++++ src/Matrix.cpp | 77 +++--------------------------- src/Matrix.h | 24 ++++------ src/Vect.cpp | 39 ++++++--------- src/Vect.h | 7 +-- src/main.cpp | 31 +++++------- test/test_solver.cpp | 3 +- 10 files changed, 224 insertions(+), 193 deletions(-) create mode 100644 src/IO.cpp create mode 100644 src/IO.h diff --git a/src/Gauss.cpp b/src/Gauss.cpp index 60513ee..6234e10 100644 --- a/src/Gauss.cpp +++ b/src/Gauss.cpp @@ -4,72 +4,66 @@ namespace Gauss { -static void GaussNonJordan(Matrix& mat, bool reduite) { - int r = -1; - for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { - std::size_t indice_ligne_maximum = r + 1; - - // Recherche maximum - for (std::size_t i = r + 1; i < mat.GetRawCount(); i++) { - if (std::abs(mat.at(i, j)) > std::abs(mat.at(indice_ligne_maximum, j))) - indice_ligne_maximum = i; - } - - // Si A[k,j]≠0 alors (A[k,j] désigne la valeur de la ligne k et de la colonne j) - if (!IsEqualZero(mat.at(indice_ligne_maximum, j))) { - r++; - - // Si k≠r alors - if (indice_ligne_maximum != r) { - // Échanger les lignes k et r (On place la ligne du pivot en position r) - for (std::size_t k = 0; k < mat.GetColumnCount(); k++) { - std::swap(mat.at(indice_ligne_maximum, k), mat.at(r, k)); - } - } - - // Pour i de 1 jusqu'à n (On simplifie les autres lignes) - for (std::size_t i = (reduite ? 0 : j); i < mat.GetRawCount(); i++) { - // Si i≠r alors - if (i != r) { - // Soustraire à la ligne i la ligne r multipliée par A[i,j] (de façon à - // annuler A[i,j]) - for (int k = mat.GetColumnCount() - 1; k >= 0; k--) { - long double pivot = mat.at(r, j); - long double anul = mat.at(i, j); - mat.at(i, k) = mat.at(i, k) * pivot - mat.at(r, k) * anul; - } - } - } - } +static void SwapLines(Matrix& mat, std::size_t line1, std::size_t line2) { + for (std::size_t k = 0; k < mat.GetColumnCount(); k++) { + std::swap(mat.at(line1, k), mat.at(line2, k)); } } -static void GaussJordan(Matrix& mat, bool reduite) { - GaussNonJordan(mat, reduite); - for (std::size_t i = 0; i < mat.GetRawCount(); i++) { - int k = -1; - for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { - if (!IsEqualZero(mat.at(i, j))) { - k = j; - break; - } - } - // ligne de 0 - if (k == -1) - break; - // on divise la ligne par (i, k) - long double annul = mat.at(i, k); - for (int j = 0; j < mat.GetColumnCount(); j++) { - mat.at(i, j) /= annul; +static void DivideLine(Matrix& mat, std::size_t line, Matrix::Element number) { + for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { + mat.at(line, j) /= number; + } +} + +static int FirstNotNullElementIndexOnColumn(Matrix& mat, std::size_t column, std::size_t startLine = 0) { + for (std::size_t i = startLine; i < mat.GetRawCount(); i++) { + if (!IsEqualZero(mat.at(i, column))) { + return i; } } + return -1; +} + +static void SimplifyLine(Matrix& mat, std::size_t line, std::size_t pivot_line, std::size_t pivot_column) { + const Matrix::Element pivot = mat.at(pivot_line, pivot_column); + const Matrix::Element anul = mat.at(line, pivot_column); + + for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { + mat.at(line, j) = mat.at(line, j) * pivot - mat.at(pivot_line, j) * anul; + } } void GaussJordan(Matrix& mat, bool reduite, bool normalise) { - if (normalise) - GaussJordan(mat, reduite); - else - GaussNonJordan(mat, reduite); + int indice_ligne_pivot = -1; + + for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { + + int indice_ligne_pivot_trouve = FirstNotNullElementIndexOnColumn(mat, j, indice_ligne_pivot + 1); + + if (indice_ligne_pivot_trouve < 0) // colonne de 0 + continue; // on regarde la prochaine colonne + + indice_ligne_pivot++; + + if (indice_ligne_pivot_trouve != indice_ligne_pivot) { + SwapLines(mat, indice_ligne_pivot_trouve, indice_ligne_pivot); + } + + Matrix::Element pivot = mat.at(indice_ligne_pivot, j); + + if (normalise) { + DivideLine(mat, indice_ligne_pivot, pivot); + } + + // On simplifie les autres lignes + for (std::size_t i = (reduite ? 0 : j); i < mat.GetRawCount(); i++) { + // Pour les lignes autre que la ligne pivot + if (i != static_cast(indice_ligne_pivot)) { + SimplifyLine(mat, i, indice_ligne_pivot, j); + } + } + } } } // namespace Gauss \ No newline at end of file diff --git a/src/Gauss.h b/src/Gauss.h index 168919a..5116a27 100644 --- a/src/Gauss.h +++ b/src/Gauss.h @@ -4,6 +4,12 @@ class Matrix; namespace Gauss { +/** + * \brief Echelonne une matrice en utilisant l'algorithme de Gauss-Jordan + * \param mat La matrice à échelonner + * \param reduite Mets des 0 au dessus des pivots + * \param normalise Mets les pivots à 1 + */ void GaussJordan(Matrix& mat, bool reduite, bool normalise); } // namespace Gauss \ No newline at end of file diff --git a/src/IO.cpp b/src/IO.cpp new file mode 100644 index 0000000..800a3cd --- /dev/null +++ b/src/IO.cpp @@ -0,0 +1,101 @@ +#include "IO.h" + +#include "Vect.h" +#include +#include + +std::ostream& operator<<(std::ostream& stream, const Matrix& mat) { + stream << mat.GetRawCount() << " " << mat.GetColumnCount() << "\n"; + for (std::size_t i = 0; i < mat.GetRawCount(); i++) { + for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { + stream << mat.at(i, j) << " "; + } + stream << "\n"; + } + return stream; +} + +std::istream& operator>>(std::istream& stream, Matrix& mat) { + std::size_t raw, column; + stream >> raw >> column; + + Matrix result {raw, column}; + mat = result; + + for (std::size_t i = 0; i < mat.GetRawCount(); i++) { + for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { + stream >> mat.at(i, j); + } + } + + return stream; +} + +Matrix LoadMatrix(const std::string& fileName) { + std::ifstream in {fileName}; + if (!in) { + std::cerr << "Impossible de charger la matrice !\n"; + return {}; + } + Matrix result; + in >> result; + + return result; +} + +void SaveMatrix(const Matrix& mat, const std::string& fileName) { + std::ofstream out {fileName}; + if (!out) { + std::cerr << "Impossible de sauvegarder la matrice !\n"; + return; + } + out << mat; +} + +Matrix InsertMatrix() { + std::cout << "Quelle est le nombre de lignes de votre matrice ?" << std::endl; + std::size_t lignes; + std::cin >> lignes; + std::cout << "Quelle est le nombre de colonnes de votre matrice ?" << std::endl; + std::size_t colonnes; + std::cin >> colonnes; + std::cout << "Rentrez les coefficients de la matrice" << std::endl; + Matrix result(lignes, colonnes); + for (size_t i = 0; i < result.GetRawCount(); ++i) { + for (size_t j = 0; j < result.GetColumnCount(); ++j) { + std::cin >> result.at(i, j); + } + std::cout << std::endl; + } + + return result; +} + +void Print(const Matrix& mat) { + for (size_t i = 0; i < mat.GetRawCount(); ++i) { + std::cout << "[ "; + for (size_t j = 0; j < mat.GetColumnCount(); ++j) { + std::cout << mat.at(i, j) << " "; + } + std::cout << "]"; + std::cout << std::endl; + } +} + +void Print(const Vect& vect) { + std::cout << "Espace vectoriel de dimension " << vect.GetCardinal() << " de base :\n\n"; + for (std::size_t i = 0; i < vect.GetDimension(); i++) { + for (std::size_t j = 0; j < vect.GetCardinal(); j++) { + Matrix vector = vect.GetVector(j); + std::cout << "[ " << vector.at(i, 0) << " ]\t"; + } + std::cout << "\n"; + } +} + +void Print(const VectAffine& vect) { + std::cout << "\tEspace Affine :\n\n"; + Print(vect.GetBase()); + std::cout << "\nOrigine :\n\n"; + Print(vect.GetOrigin()); +} \ No newline at end of file diff --git a/src/IO.h b/src/IO.h new file mode 100644 index 0000000..54732c6 --- /dev/null +++ b/src/IO.h @@ -0,0 +1,19 @@ +#pragma once + +#include + +class Matrix; +class Vect; +class VectAffine; + +std::ostream& operator<<(std::ostream& stream, const Matrix& mat); +std::istream& operator>>(std::istream& stream, Matrix& mat); + +Matrix LoadMatrix(const std::string& fileName); +void SaveMatrix(const Matrix& mat, const std::string& fileName); + +Matrix InsertMatrix(); + +void Print(const Matrix& mat); +void Print(const Vect& vect); +void Print(const VectAffine& vect); \ No newline at end of file diff --git a/src/Matrix.cpp b/src/Matrix.cpp index 244b36c..5f36544 100644 --- a/src/Matrix.cpp +++ b/src/Matrix.cpp @@ -1,20 +1,17 @@ #include "Matrix.h" +#include "IO.h" #include #include #include #include #include -Matrix::Matrix(const std::string& fileNameInput) { - Load(fileNameInput); -} - Matrix::Matrix(std::size_t lignes, std::size_t colonnes) : m_Raws(lignes), m_Columns(colonnes) { m_Data.resize(m_Raws * m_Columns); } -Matrix::Matrix(std::size_t lignes, std::size_t colonnes, std::initializer_list&& initList) : +Matrix::Matrix(std::size_t lignes, std::size_t colonnes, std::initializer_list&& initList) : m_Raws(lignes), m_Columns(colonnes) { m_Data = initList; m_Data.resize(m_Raws * m_Columns); @@ -25,14 +22,14 @@ Matrix::~Matrix() {} Matrix Matrix::operator*(const Matrix& other) const { if (m_Columns != other.m_Raws) { std::cerr << "Mutiplication impossible car la dimensions des matrices est incompatible" << std::endl; - return {1, 1, {0}}; + return {}; } Matrix result(m_Raws, other.m_Columns); for (std::size_t i = 0; i < m_Raws; ++i) { for (std::size_t j = 0; j < other.m_Columns; ++j) { - long double sum = 0; + Element sum = 0; for (std::size_t k = 0; k < m_Columns; k++) { sum += at(i, k) * other.at(k, j); } @@ -42,44 +39,6 @@ Matrix Matrix::operator*(const Matrix& other) const { return result; } -void Matrix::Print() const { - for (size_t i = 0; i < m_Raws; ++i) { - std::cout << "[ "; - for (size_t j = 0; j < m_Columns; ++j) { - std::cout << at(i, j) << " "; - } - std::cout << "]"; - std::cout << std::endl; - } -} - -void Matrix::Insert() { - for (size_t i = 0; i < m_Raws; ++i) { - for (size_t j = 0; j < m_Columns; ++j) { - std::cin >> at(i, j); - } - std::cout << std::endl; - } -} - -void Matrix::Save(const std::string& fileName) { - std::ofstream out {fileName}; - if (!out) { - std::cerr << "Impossible de sauvegarder la matrice !\n"; - return; - } - out << *this; -} - -void Matrix::Load(const std::string& filename) { - std::ifstream in {filename}; - if (!in) { - std::cerr << "Impossible de charger la matrice !\n"; - return; - } - in >> *this; -} - void Matrix::Transpose() { Matrix result {m_Columns, m_Raws}; for (std::size_t i = 0; i < m_Raws; i++) { @@ -133,15 +92,15 @@ bool Matrix::operator==(const Matrix& other) const { return true; } -long double& Matrix::operator[](std::size_t indice) { +Matrix::Element& Matrix::operator[](std::size_t indice) { return m_Data[indice]; } -long double& Matrix::at(std::size_t ligne, std::size_t colonne) { +Matrix::Element& Matrix::at(std::size_t ligne, std::size_t colonne) { return m_Data[ligne * m_Columns + colonne]; } -long double Matrix::at(std::size_t ligne, std::size_t colonne) const { +Matrix::Element Matrix::at(std::size_t ligne, std::size_t colonne) const { return m_Data[ligne * m_Columns + colonne]; } @@ -165,25 +124,3 @@ Matrix Matrix::SubMatrix(std::size_t origine_ligne, std::size_t origine_colonne, return result; } - -std::ostream& operator<<(std::ostream& stream, const Matrix& mat) { - stream << mat.m_Raws << " " << mat.m_Columns << "\n"; - for (std::size_t i = 0; i < mat.m_Raws; i++) { - for (std::size_t j = 0; j < mat.m_Columns; j++) { - stream << mat.at(i, j) << " "; - } - stream << "\n"; - } - return stream; -} - -std::istream& operator>>(std::istream& stream, Matrix& mat) { - stream >> mat.m_Raws >> mat.m_Columns; - mat.m_Data.resize(mat.m_Raws * mat.m_Columns); - for (std::size_t i = 0; i < mat.m_Raws; i++) { - for (std::size_t j = 0; j < mat.m_Columns; j++) { - stream >> mat.at(i, j); - } - } - return stream; -} diff --git a/src/Matrix.h b/src/Matrix.h index 2d34ded..a0ee3fb 100644 --- a/src/Matrix.h +++ b/src/Matrix.h @@ -6,26 +6,23 @@ #include class Matrix { + public: + typedef long double Element; + private: std::size_t m_Raws; std::size_t m_Columns; - std::vector m_Data; + std::vector m_Data; public: - Matrix(const std::string& fileNameInput); + Matrix() : m_Raws(0), m_Columns(0) {} Matrix(std::size_t raws, std::size_t columns); - Matrix(std::size_t raws, std::size_t columns, std::initializer_list&& initList); + Matrix(std::size_t raws, std::size_t columns, std::initializer_list&& initList); ~Matrix(); std::size_t GetRawCount() const; std::size_t GetColumnCount() const; - void Insert(); - void Print() const; - - void Save(const std::string& fileName); - void Load(const std::string& filename); - void Transpose(); static Matrix Identity(std::size_t size); @@ -36,13 +33,10 @@ class Matrix { bool operator==(const Matrix& other) const; Matrix operator*(const Matrix& other) const; - long double& operator[](std::size_t index); + Element& operator[](std::size_t index); - long double& at(std::size_t raw, std::size_t column); - long double at(std::size_t raw, std::size_t column) const; - - friend std::ostream& operator<<(std::ostream& stream, const Matrix& mat); - friend std::istream& operator>>(std::istream& stream, Matrix& mat); + Element& at(std::size_t raw, std::size_t column); + Element at(std::size_t raw, std::size_t column) const; }; template diff --git a/src/Vect.cpp b/src/Vect.cpp index 3b3e7a7..58990cc 100644 --- a/src/Vect.cpp +++ b/src/Vect.cpp @@ -5,6 +5,15 @@ #include #include +static bool IsColumnNull(Matrix& mat, std::size_t column) { + for (std::size_t i = 0; i < mat.GetRawCount(); i++) { + if (!IsEqualZero(mat.at(i, column))) { + return false; + } + } + return true; +} + Vect::Vect(const Matrix& mat) : m_Data(mat) { Simplify(); } @@ -12,12 +21,7 @@ Vect::Vect(const Matrix& mat) : m_Data(mat) { void Vect::Simplify() { Matrix mat = m_Data; for (std::size_t j = 0; j < mat.GetColumnCount(); j++) { - std::size_t i; - for (i = 0; i < mat.GetRawCount(); i++) { - if (!IsEqualZero(mat.at(i, j))) - break; - } - if (i == mat.GetRawCount()) { + if (IsColumnNull(mat, j)) { m_Data = mat.SubMatrix(0, 0, mat.GetRawCount(), j); return; } @@ -25,6 +29,10 @@ void Vect::Simplify() { m_Data = mat; } +Matrix Vect::GetVector(std::size_t index) const { + return m_Data.SubMatrix(0, index, m_Data.GetRawCount(), 1); +} + std::size_t Vect::GetCardinal() const { return m_Data.GetColumnCount(); } @@ -65,26 +73,9 @@ Matrix Vect::GetLinearSystem() const { return vect; } -void Vect::Print() const { - std::cout << "Espace vectoriel de dimension " << GetCardinal() << " de base :\n\n"; - for (std::size_t i = 0; i < m_Data.GetRawCount(); i++) { - for (std::size_t j = 0; j < m_Data.GetColumnCount(); j++) { - std::cout << "[ " << m_Data.at(i, j) << " ]\t"; - } - std::cout << "\n"; - } -} - std::size_t Vect::GetDimension() const { return m_Data.GetRawCount(); } VectAffine::VectAffine(const Vect& base, const Matrix& origine) : - m_Base(base), m_Origin(origine.SubMatrix(0, 0, m_Base.GetDimension(), 1)) {} - -void VectAffine::Print() const { - std::cout << "\tEspace Affine :\n\n"; - m_Base.Print(); - std::cout << "\nOrigine :\n\n"; - m_Origin.Print(); -} + m_Base(base), m_Origin(origine.SubMatrix(0, 0, m_Base.GetDimension(), 1)) {} \ No newline at end of file diff --git a/src/Vect.h b/src/Vect.h index 64b587e..d540a44 100644 --- a/src/Vect.h +++ b/src/Vect.h @@ -15,10 +15,7 @@ class Vect { */ Vect(const Matrix& mat); - /** - * \brief Affiche la base de l'espace vectoriel dans la console - */ - void Print() const; + Matrix GetVector(std::size_t index) const; std::size_t GetDimension() const; std::size_t GetCardinal() const; @@ -46,8 +43,6 @@ class VectAffine { public: VectAffine(const Vect& base, const Matrix& origin); - void Print() const; - const Vect& GetBase() const { return m_Base; } diff --git a/src/main.cpp b/src/main.cpp index 114bb8e..169b909 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,6 +1,7 @@ +#include "Gauss.h" +#include "IO.h" #include "Matrix.h" #include "NR.h" -#include "Gauss.h" #include "Solver.h" #include @@ -19,8 +20,8 @@ void test() { mat.Print(); // mat.Save("matrice4x4echelonne.mat"); */ - Matrix mat2 {"matrice4x4.mat"}; - mat2.Print(); + Matrix mat2 = LoadMatrix("matrice4x4.mat"); + Print(mat2); Solver solver {mat2}; @@ -28,35 +29,27 @@ void test() { Vect noyau = solver.Kernel(); std::cout << "\tImage :\n"; - image.Print(); + Print(image); std::cout << "Système :\n"; - image.GetLinearSystem().Print(); + Print(image.GetLinearSystem()); std::cout << "\tNoyau :\n"; - noyau.Print(); + Print(noyau); std::cout << "Système :\n"; - noyau.GetLinearSystem().Print(); + Print(noyau.GetLinearSystem()); std::cout << "\n\n"; - solver.TriangularSystem().Print(); + Print(solver.TriangularSystem()); } void prompt() { - std::cout << "Quelle est le nombre de lignes de votre matrice ?" << std::endl; - std::size_t lignes; - std::cin >> lignes; - std::cout << "Quelle est le nombre de colonnes de votre matrice ?" << std::endl; - std::size_t colonnes; - std::cin >> colonnes; - std::cout << "Rentrez les coefficients de la matrice" << std::endl; - Matrix mat(lignes, colonnes); - mat.Insert(); + Matrix mat = InsertMatrix(); - mat.Print(); + Print(mat); Gauss::GaussJordan(mat, true, true); - mat.Print(); + Print(mat); } int main(int argc, char** argv) { diff --git a/test/test_solver.cpp b/test/test_solver.cpp index cfe6e7e..51a5fd9 100644 --- a/test/test_solver.cpp +++ b/test/test_solver.cpp @@ -3,6 +3,7 @@ #include #include +#include "IO.h" #include "Solver.h" namespace fs = std::filesystem; @@ -16,7 +17,7 @@ int main() { std::ifstream in {fileName}; - Matrix mat {1, 1}, imageMat {1, 1}, noyauMat {1, 1}; + Matrix mat, imageMat, noyauMat; in >> mat >> imageMat >> noyauMat; Vect image {imageMat}; From 54346dc77f61fcc347cadfbfe85b3a2abd0d50b5 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 15:10:12 +0100 Subject: [PATCH 14/45] add some doc --- src/Matrix.h | 4 ++++ src/Solver.h | 26 ++++++++++++++++++++++++++ src/Vect.h | 38 ++++++++++++++++++++++++++++++++++++-- 3 files changed, 66 insertions(+), 2 deletions(-) diff --git a/src/Matrix.h b/src/Matrix.h index a0ee3fb..3d578c3 100644 --- a/src/Matrix.h +++ b/src/Matrix.h @@ -5,6 +5,10 @@ #include #include +/** + * \class Matrix + * \brief Représente une matrice d'éléments +*/ class Matrix { public: typedef long double Element; diff --git a/src/Solver.h b/src/Solver.h index 2d6bbf5..5f6f5a7 100644 --- a/src/Solver.h +++ b/src/Solver.h @@ -2,19 +2,45 @@ #include "Vect.h" +/** + * \class Solver + * \brief Permet d'obtenir différentes propriétés d'une matrice comme l'image ou le noyau + */ class Solver { private: Matrix m_Matrix; public: + /** + * \brief Initialise le resolveur + * \param mat La matrice d'entrée + */ Solver(const Matrix& mat); ~Solver() {} + /** + * \brief Calcule l'image de la matrice d'entrée + * \return L'espace vectoriel correspondant + */ Vect Image() const; + + /** + * \brief Calcule le noyau de la matrice d'entrée + * \return L'espace vectoriel correspondant + */ Vect Kernel() const; + /** + * \brief Résout le système triangulaire de la forme AX=B. + * La matrice d'entrée est considéré comme étant la matrice augmenté [A|B] + * \return L'espace affine associé + */ VectAffine TriangularSystem() const; + /** + * \brief Calcule le rang de la matrice + * \note Ceci équivaut à \code Image().GetCardinal() \endcode + */ std::size_t Rank() const; }; \ No newline at end of file diff --git a/src/Vect.h b/src/Vect.h index d540a44..a771d05 100644 --- a/src/Vect.h +++ b/src/Vect.h @@ -2,7 +2,10 @@ #include "Matrix.h" -// espace vectoriel +/** + * \class Vect + * \brief Représente une base d'un espace vectoriel de dimension finie + */ class Vect { private: Matrix m_Data; @@ -10,16 +13,32 @@ class Vect { public: /** * \brief Construit une base d'un espace vectoriel à partir des colonnes d'une matrice. - * Ne prend pas en compte les colonnes de 0 + * Les colonnes de 0 sont ignorées * \param mat Une matrice échelonnée. */ Vect(const Matrix& mat); + /** + * \brief Permet d'obtenir le ieme vecteur de la base + * \param index l'index du vecteur souhaité + * \return Une matrice colonne + */ Matrix GetVector(std::size_t index) const; + /** + * \brief Retourne le nombre de coordonnées des vecteurs de la base (leur nombre de colonne) + */ std::size_t GetDimension() const; + + /** + * \brief Retourne le nombre de vecteur de la base + */ std::size_t GetCardinal() const; + /** + * \brief Exprime l'espace vectoriel comme les solutions d'un système linéaire des coordonnées des vecteurs + * \return Une matrice représentant le système linéaire + */ Matrix GetLinearSystem() const; /** @@ -35,18 +54,33 @@ class Vect { void Simplify(); }; +/** + * \class VectAffine + * \brief Représente un espace affine + */ class VectAffine { private: Vect m_Base; Matrix m_Origin; public: + /** + * \brief Construit un espace affine à partir d'un espace vectoriel et d'une origine + * \param base La base de l'espace vectoriel + * \param origin Le vecteur d'origine (matrice colonne) + */ VectAffine(const Vect& base, const Matrix& origin); + /** + * \brief Retourne l'espace vectoriel correspondant + */ const Vect& GetBase() const { return m_Base; } + /** + * \brief Retourne l'origine de l'espace affine + */ const Matrix& GetOrigin() const { return m_Origin; } From 7c75728180b2b9497bfd9716bd3e6ea139f464ee Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 21:48:27 +0100 Subject: [PATCH 15/45] better assert --- src/Matrix.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Matrix.cpp b/src/Matrix.cpp index 5f36544..c27919c 100644 --- a/src/Matrix.cpp +++ b/src/Matrix.cpp @@ -113,7 +113,8 @@ std::size_t Matrix::GetColumnCount() const { } Matrix Matrix::SubMatrix(std::size_t origine_ligne, std::size_t origine_colonne, std::size_t ligne, std::size_t colonne) const { - assert(m_Raws >= ligne && m_Columns >= colonne); + assert(m_Raws >= origine_ligne + ligne && m_Columns >= origine_colonne + colonne); + Matrix result {ligne, colonne}; for (std::size_t i = 0; i < ligne; i++) { From 46adc200d1aa1b89f3bdbca0ce8315c343c229fd Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 22:23:17 +0100 Subject: [PATCH 16/45] add doxygen-awesome-css --- .gitmodules | 3 +++ doc/doxygen-awesome-css | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 doc/doxygen-awesome-css diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..3847d26 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doc/doxygen-awesome-css"] + path = doc/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css diff --git a/doc/doxygen-awesome-css b/doc/doxygen-awesome-css new file mode 160000 index 0000000..c01e51e --- /dev/null +++ b/doc/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit c01e51e461a5f0d45422aa21cdf4e50181d04a19 From 9028b553c300c9a21987572663312cc0b07ddf59 Mon Sep 17 00:00:00 2001 From: Persson-dev Date: Thu, 29 Feb 2024 22:23:30 +0100 Subject: [PATCH 17/45] add doxygen config --- doxyfile | 2736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 2736 insertions(+) create mode 100644 doxyfile diff --git a/doxyfile b/doxyfile new file mode 100644 index 0000000..c208af9 --- /dev/null +++ b/doxyfile @@ -0,0 +1,2736 @@ +# Doxyfile 1.9.4 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Pivot" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = build + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# numer of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = French + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE = NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = include \ + README.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = "README.md" + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doc/doxygen-awesome-css/doxygen-awesome.css \ + doc/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + doc/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /