Dokumentation

Übersicht:

• Installation
• Funktionen
  • Conv.MathToLatex()
  • Export.AsText()
  • Export.AsImage() (Coming Soon)
  • Wrapper.PrettyPrint()
  • Wrapper.PrintBrackets()
• Enum-Objekte
  • TextFormats
  • ImageFormats
  • WriteModes
  • BracketModes
• Konfiguration
  • Alle Config-Optionen

Installation

Die Datei MaTeX.cs im Projektordner speichern. Und mit using MaTeX; importieren.

Funktionen

Conv.MathToLatex()

Wandelt Terme bzw. Gleichungen in Form von string's sowie verschiedene C#-Objekte aus MathNet.Numerics.LinearAlgebra in LaTeX-Schreibweise um.

string MathToLatex(object obj)

Unterstützte Terme bzw. Gleichungen:

• mehrere =-Zeichen
• Operationen: +, -, *, /, ^
• mathematische Funktionen wie z.B.: sin(), cos(), tan(), ... , arcsin(), ... , sqrt(), exp()

• z.B. nicht Unterstützt: f(x)

Unterstützte MathNet.Numerics.LinearAlgebra-Objekte:

• Matrix
• Vector

Beispiel:

// Objekte definieren
string S = "0 = 3*2-sqrt(x)";
Vector V = DenseVector.OfArray(new double[] {4,7,1});
Matrix M = DenseMatrix.OfArray(new double[,] {
    {1,5,0},
    {0,3,0},
    {4,0,1}
});

// LaTeX-Code genrerieren
string S_latex = Conv.MathToLatex(S);
string V_latex = Conv.MathToLatex(V);
string M_latex = Conv.MathToLatex(M);

// LaTeX-Code anzeigen
Console.WriteLine(S_latex + "\n");
Console.WriteLine(V_latex + "\n");
Console.WriteLine(M_latex + "\n");

Ausgabe:

0 = 6 - \sqrt{x}

\begin{pmatrix}
4 \\
7 \\
1 
\end{pmatrix}

\begin{bmatrix}
1 & 5 & 0 \\
0 & 3 & 0 \\
4 & 0 & 1 
\end{bmatrix}

Export.AsText()

Speichert LaTeX-Code in Form von string's in unterschiedlichen Formaten aus TextFormats in der Datei filename ab. Dabei kann der Schreibmodus aus WriteModes gewählt werden. Zusätzlich können Klammermodi aus BracketModes für Markdown bzw. LaTeX Formate verwendet werden.

bool AsText(string latex, string filename, WriteModes writeMode, TextFormats textFormat, BracketModes[] bracketModes)

Unterstützte Dateinamen:

• filename darf nur den Dateinamen, keinen Dateipfad enthalten.
• Der Standard Dateipfad kann in Config.SaveLocation festgelegt werden.
• Wenn filename keine Dateiendung enthält, wird diese durch textFormat festgelegt:

Unterstützte Schreibmodi aus WriteModes:

Unterstützte Dateiformate aus TextFormats:

Unterstützte Klammermodi aus BracketModes für TextFormats.TEX, TextFormats.TEX_DOCUMENT und TextFormats.MD:

Beispiel:

Objekte S, V, M und deren LaTeX-Code S_latex, V_latex, M_latex aus dem MathToLatex-Beispiel verwenden

string FileName = "Beispiel_ExportAsText";

// Export (I)
Export.AsText(
    S_latex,
    FileName,
    WriteModes.OVERRIDE, // (Default)
    TextFormats.TEX_DOCUMENT,
    new BracketModes[] {BracketModes.BEGIN, BracketModes.END} // (Default)
);

// Export (II)
Export.AsText(
    M_latex + @"\cdot",
    FileName,
    WriteModes.INSERT_BEFORE_DOCUMENT_END,
    TextFormats.TEX, // (Default)
    new BracketModes[] {BracketModes.BEGIN}
);

// Export (III)
Export.AsText(
    V_latex,
    FileName,
    WriteModes.INSERT_BEFORE_DOCUMENT_END,
    TextFormats.TEX, // (Default)
    new BracketModes[] {BracketModes.END}
);

// oder mit Export (II) und (III) kombiniert
Export.AsText(
    M_latex + @"\cdot" + V_latex,
    FileName,
    WriteModes.INSERT_BEFORE_DOCUMENT_END,
    TextFormats.TEX, // (Default)
    new BracketModes[] {BracketModes.BEGIN, BracketModes.END} // (Default)
);

Mit Default markierte Parameter sind optional und können über die jeweilige Config-Option global konfiguriert werden.

Ausgabe: Beispiel_ExportAsText.tex

\documentclass[10pt]{article}   % Export (I)
                                %  |
\begin{document}                %  |
                                %  |
\begin{equation*}               %  |
0 = 6 - \sqrt{x}                %  |
\end{equation*}                 %  |

\begin{equation*}               % Export (II)
\begin{bmatrix}                 %  |
1 & 5 & 0 \\                    %  |
0 & 3 & 0 \\                    %  |
4 & 0 & 1                       %  |
\end{bmatrix}\cdot              %  |

\begin{pmatrix}                 % Export (III)
4 \\                            %  |
7 \\                            %  |
1                               %  |
\end{pmatrix}                   %  |
\end{equation*}                 %  |

\end{document}                  % Export (I)

Export.AsImage() (Coming Soon)

Rendert LaTeX-Code in Form von string's und speichert es als Bild.

bool AsImage(string latex, string filename, ImageFormats imageFormat)

Unterstützte Dateinamen:

• filename darf nur den Dateinamen, keinen Dateipfad enthalten.
• Der Standard Dateipfad kann in Config.SaveLocation festgelegt werden.
• Die Dateiendung wird durch imageFormat festgelegt:

Wrapper.PrettyPrint()

Gibt text zurück, wenn Config.PrettyPrinting mit true konfiguriert ist, sonst alternative.

string PrettyPrint(string text, string alternative)

Wrapper.PrintBrackets()

Gibt bracketText zurück, wenn der Klammermodus currentMode im Array der akzeptierten Klammermodi compareModes enthalten ist, sont alternative.

string PrintBrackets(string bracketText, string alternative, BracketModes currentMode, BracketModes[] compareModes)

Enum-Objekte

TextFormats

enum TextFormats { TXT, MD, TEX, TEX_DOCUMENT }

ImageFormats

enum ImageFormats { JPG, JPEG, BMP, PNG, GIF, SVG }

WriteModes

enum WriteModes { OVERRIDE, APPEND, AT_START, INSERT_AFTER_DOCUMENT_START, INSERT_BEFORE_DOCUMENT_END }

BracketModes

enum BracketModes { BEGIN, END }

Konfiguration

In der Config-Klasse können einheitlich Formate, Modi und Eigenschaften etc. konfiguriert werden. Diese Werte werden zum Beispiel zur Vervollständigung von Überladenen Funktionen sowie als Bedingung in Wrapper-Funktionen verwendet. Sie können aber auch einfach abgefragt oder geändert werden:

Config.SaveLocation = Path.GetFullPath("dein/neuer/Speicherpfad");
Config.PrettyPrinting = false;
Config.TextFormat = TextFormats.MD;
...

Vervollständigung von Überladenen Funktionen:

Hier wird eine Überladung der Export.AsText()-Funktion mit weniger Parametern verwendet, nämlich:

bool AsText(string latex, string filename, TextFormats textFormat)

Export.AsText(
    Conv.MathToLatex("0=6-\sqrt{x}"),
    "ergebnis",
    TextFormats.TEX_DOCUMENT
);

Die in dieser Überladung 'fehlenden Paramter' sind writeMode und bracketModes. Beim Aufruf der 'vollständigen' Export.AsText()-Funktion werden für diese fehlenden Parameter die konfigurierten Werte Config.WriteMode und Config.BracketModes eingesetzt.

Alle Config-Optionen