Exporting help in the TXT format | mXparser – Math Expressions Parser for JAVA, C#, C++, Kotlin, Android, .NET/MONO/Xamarin – Mathematical Formula Parser / Evaluator Library

TO SUPPORT MY WORK, ORDER A COMMERCIAL LICENSE

ORDER Pageor INFIMA Store

THANK YOU!

The tutorial consists of more than 200 live examples from 50 sections given separately for JAVA, C# and C++. Each of the examples can be copied and run on your own environment. In addition, mXparser provides an extensive collection of over 500 built-in math functions, expressions and symbols. Familiarize yourself with the scope and the syntax. Live testing is the best way to learn. Good luck! 🙂

Tutorial Math Collection API spec Download

Below is the code for JAVA, C# (the code for C# is almost identical) and C++. To copy the code, double-click inside the frame.

List of available options

Java/C# code

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Only built-in elements
String mXparser.getHelp(String query);
String mXparser.getHelp(boolean addHeader, boolean addCaption, String caption);
String mXparser.getHelp(String query, boolean addHeader, boolean addCaption, String caption);

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...

// Also with user-defined elements, when e is an instance of Expression
String e.getHelp(String query);
String e.getHelp(boolean addHeader, boolean addCaption, String caption);
String e.getHelp(String query, boolean addHeader, boolean addCaption, String caption);

C++ code

#include "org/mariuszgromada/math/mxparser.hpp"
// ...

// Only built-in elements
StringPtr mXparser::getHelp(const std::string &query);
StringPtr mXparser::getHelp(bool addHeader, bool addCaption, const std::string &caption);
StringPtr mXparser::getHelp(const std::string &query, bool addHeader, bool addCaption, const std::string &caption);

#include "org/mariuszgromada/math/mxparser.hpp"
// ...

// Also with user-defined elements, when e is an instance of ExpressionPtr
StringPtr e->getHelp(const std::string &query);
StringPtr e->getHelp(bool addHeader, bool addCaption, const std::string &caption);
StringPtr e->getHelp(const std::string &query, bool addHeader, bool addCaption, const std::string &caption);

Query parameter syntax

For a basic in-line search, simply provide a word (e.g.: `"sine"`) in the `query` parameter.

Advanced search is also possible, please use one of the tags below when formatting the `query` parameter:

"key=" – keyword (e.g.: "key=sin")
"desc=" – description (e.g.: "desc=trigonometric"),
"syn=" – syntax (e.g.: "syn=sin")
"type=" – type (e.g.: "type=unit")
"since=" – since (e.g.: "since=4.1")
"typeid=" – please refer to parser tokens (e.g.: "typeid=3")
"keyid=" – please refer to parser tokens (e.g.: "keyid=1004").

Only one tag can be used per search.

Other parameters

Other parameters are self-explanatory by their names. In case you need more details please refer the API documentation.

Case 1: Output with header and standard caption + advanced search

Java/C# code

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
mXparser.consolePrint("\n");
String helpTxt = mXparser.getHelp("type=Bitwise operator", true, true, "");

mXparser.consolePrintln(helpTxt);

C++ code

#include "org/mariuszgromada/math/mxparser.hpp"
// ...
mXparser::consolePrint("\n");
StringPtr helpTxt = mXparser::getHelp("type=Bitwise operator", true, true, "");

mXparser::consolePrintln(helpTxt);

Code result

[mXparser-v.5.2.0] 
Help content limited to query: 'type=Bitwise operator'
  #  Keyword             Type                    Syntax                                        Since Description
  -  --------            ----                    ------                                        ----- -----------
  1. @~                  <Bitwise operator>      @~a                                           4.0   Bitwise unary complement - Bitwise operator
  2. @&                  <Bitwise operator>      a @& b                                        4.0   Bitwise and AND - Bitwise operator
  3. @^                  <Bitwise operator>      a @^ b                                        4.0   Bitwise exclusive or XOR - Bitwise operator
  4. @|                  <Bitwise operator>      a @| b                                        4.0   Bitwise inclusive or OR - Bitwise operator
  5. @<<                 <Bitwise operator>      a @<< b                                       4.0   Signed left shift - Bitwise operator
  6. @>>                 <Bitwise operator>      a @>> b                                       4.0   Signed right shift - Bitwise operator

Case 2: Output with header and user caption + advanced search

Java/C# code

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
mXparser.consolePrint("\n");
String helpTxt = mXparser.getHelp("type=Bitwise operator", true, true, "This is a caption");

mXparser.consolePrintln(helpTxt);

C++ code

#include "org/mariuszgromada/math/mxparser.hpp"
// ...
mXparser::consolePrint("\n");
StringPtr helpTxt = mXparser::getHelp("type=Bitwise operator", true, true, "This is a caption");

mXparser::consolePrintln(helpTxt);

Code result

[mXparser-v.5.2.0] 
This is a caption
  #  Keyword             Type                    Syntax                                        Since Description
  -  --------            ----                    ------                                        ----- -----------
  1. @~                  <Bitwise operator>      @~a                                           4.0   Bitwise unary complement - Bitwise operator
  2. @&                  <Bitwise operator>      a @& b                                        4.0   Bitwise and AND - Bitwise operator
  3. @^                  <Bitwise operator>      a @^ b                                        4.0   Bitwise exclusive or XOR - Bitwise operator
  4. @|                  <Bitwise operator>      a @| b                                        4.0   Bitwise inclusive or OR - Bitwise operator
  5. @<<                 <Bitwise operator>      a @<< b                                       4.0   Signed left shift - Bitwise operator
  6. @>>                 <Bitwise operator>      a @>> b                                       4.0   Signed right shift - Bitwise operator

Case 3: Output with no header and no caption + advanced search

Java/C# code

// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
mXparser.consolePrint("\n");
String helpTxt = mXparser.getHelp("type=Bitwise operator", false, false, "This is a caption");

mXparser.consolePrintln(helpTxt);

C++ code

#include "org/mariuszgromada/math/mxparser.hpp"
// ...

Code result

[mXparser-v.5.2.0] 
  1. @~                  <Bitwise operator>      @~a                                           4.0   Bitwise unary complement - Bitwise operator
  2. @&                  <Bitwise operator>      a @& b                                        4.0   Bitwise and AND - Bitwise operator
  3. @^                  <Bitwise operator>      a @^ b                                        4.0   Bitwise exclusive or XOR - Bitwise operator
  4. @|                  <Bitwise operator>      a @| b                                        4.0   Bitwise inclusive or OR - Bitwise operator
  5. @<<                 <Bitwise operator>      a @<< b                                       4.0   Signed left shift - Bitwise operator
  6. @>>                 <Bitwise operator>      a @>> b                                       4.0   Signed right shift - Bitwise operator

Nuget – Package Manager (C#, F#, Visual Basic, …)

Install-Package MathParser.org-mXparser -Version 6.1.0

Nuget – .NET CLI

dotnet add package MathParser.org-mXparser --version 6.1.0

Nuget – Package Reference

<PackageReference Include="MathParser.org-mXparser" Version="6.1.0"/>

Maven – Dependency (Java, Kotlin, Scala, Groovy, …)

<dependency> <groupid>org.mariuszgromada.math</groupid> <artifactid>MathParser.org-mXparser</artifactid> <version>6.1.0</version> </dependency>

Maven – Gradle

implementation 'org.mariuszgromada.math:MathParser.org-mXparser:6.1.0'

CMake – Dependency / FetchContent (C++, MSVC, LLVM/Clang, GNU/GCC, MinGW, MSYS2, WSL, Windows, Linux, Unix, MacOS)

include(FetchContent) FetchContent_Declare(MathParserOrgMxParserGIT_REPOSITORYhttps://github.com/mariuszgromada/MathParser.org-mXparser.gitGIT_TAGv.6.1.0SOURCE_SUBDIR CURRENT/cpp/lib ) FetchContent_MakeAvailable(MathParserOrgMxParser) target_link_libraries(YourExecutableMathParserOrgMxParser)

GitHub

git clone https://github.com/mariuszgromada/MathParser.org-mXparser

OTHER DOWNLOAD OPTIONS

Download latest release – v.6.1.0 Sagitara: .NET bin only Download latest release – v.6.1.0 Sagitara: JAVA bin only Download latest release – v.6.1.0 Sagitara: bin + doc

NEWS FROM MATHPARSER.ORG

SOURCE CODE

Source code .zip Source code .tar.gz
View on GitHub MathSpace.pl

My other creative spaces

DONATION

Did you find the software useful?

Please consider donation 🙂

DONATE

Donation with PayPal

TO SUPPORT MY WORK, ORDER A COMMERCIAL LICENSE

THANK YOU!

Below is the code for JAVA, C# (the code for C# is almost identical) and C++. To copy the code, double-click inside the frame.

List of available options

Java/C# code

C++ code

Query parameter syntax

For a basic in-line search, simply provide a word (e.g.: "sine") in the query parameter.

Advanced search is also possible, please use one of the tags below when formatting the query parameter:

Other parameters

Case 1: Output with header and standard caption + advanced search

Java/C# code

C++ code

Code result

Case 2: Output with header and user caption + advanced search

Java/C# code

C++ code

Code result

Case 3: Output with no header and no caption + advanced search

Java/C# code

C++ code

Code result

Nuget – Package Manager (C#, F#, Visual Basic, …)

Maven – Dependency (Java, Kotlin, Scala, Groovy, …)

Maven – Gradle

CMake – Dependency / FetchContent (C++, MSVC, LLVM/Clang, GNU/GCC, MinGW, MSYS2, WSL, Windows, Linux, Unix, MacOS)

GitHub

OTHER DOWNLOAD OPTIONS

NEWS FROM MATHPARSER.ORG

SOURCE CODE

My other creative spaces

DONATION

For a basic in-line search, simply provide a word (e.g.: `"sine"`) in the `query` parameter.

Advanced search is also possible, please use one of the tags below when formatting the `query` parameter: