Exporting help in the CSV format

TO SUPPORT MY WORK, ORDER A COMMERCIAL LICENSE
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.getHelpAsCsv();
String mXparser.getHelpAsCsv(String query);
String mXparser.getHelpAsCsv(String quote, String delimiter, boolean addHeader);
String mXparser.getHelpAsCsv(String query, String quote, String delimiter, boolean addHeader);
// 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.getHelpAsCsv();
String e.getHelpAsCsv(String query);
String e.getHelpAsCsv(String quote, String delimiter, boolean addHeader);
String e.getHelpAsCsv(String query, String quote, String delimiter, boolean addHeader);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

// Only built-in elements
StringPtr mXparser::getHelpAsCsv();
StringPtr mXparser::getHelpAsCsv(const std::string &query);
StringPtr mXparser::getHelpAsCsv(const std::string &quote, const std::string &delimiter, bool addHeader);
StringPtr mXparser::getHelpAsCsv(const std::string &query, const std::string &quote, const std::string &delimiter, bool addHeader);
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

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

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 ” as text quotation and ; as delimiter + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpCsv = mXparser.getHelpAsCsv("type=Bitwise operator", "\"", ";", true);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpCsv);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpCsv = mXparser::getHelpAsCsv("type=Bitwise operator", "\"", ";", true);

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpCsv);
Code result
[mXparser-v.5.2.0] 
"Keyword";"Type";"Syntax";"Since";"Description"
"@~";"Bitwise operator";"@~a";"4.0";"Bitwise unary complement - Bitwise operator"
"@&";"Bitwise operator";"a @& b";"4.0";"Bitwise and AND - Bitwise operator"
"@^";"Bitwise operator";"a @^ b";"4.0";"Bitwise exclusive or XOR - Bitwise operator"
"@|";"Bitwise operator";"a @| b";"4.0";"Bitwise inclusive or OR - Bitwise operator"
"@<<";"Bitwise operator";"a @<< b";"4.0";"Signed left shift - Bitwise operator"
"@>>";"Bitwise operator";"a @>> b";"4.0";"Signed right shift - Bitwise operator"

Case 2: Output with header and ‘ as text quotation and , as delimiter + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpCsv = mXparser.getHelpAsCsv("type=Bitwise operator", "'", ",", true);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpCsv);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpCsv = mXparser::getHelpAsCsv("type=Bitwise operator", "'", ",", true);

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpCsv);
Code result
[mXparser-v.5.2.0] 
'Keyword','Type','Syntax','Since','Description'
'@~','Bitwise operator','@~a','4.0','Bitwise unary complement - Bitwise operator'
'@&','Bitwise operator','a @& b','4.0','Bitwise and AND - Bitwise operator'
'@^','Bitwise operator','a @^ b','4.0','Bitwise exclusive or XOR - Bitwise operator'
'@|','Bitwise operator','a @| b','4.0','Bitwise inclusive or OR - Bitwise operator'
'@<<','Bitwise operator','a @<< b','4.0','Signed left shift - Bitwise operator'
'@>>','Bitwise operator','a @>> b','4.0','Signed right shift - Bitwise operator'

Case 3: Output with header and no text quotation and ; as delimiter + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpCsv = mXparser.getHelpAsCsv("type=Bitwise operator", "", ";", true);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpCsv);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpCsv = mXparser::getHelpAsCsv("type=Bitwise operator", "", ";", true);

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpCsv);
Code result
[mXparser-v.5.2.0] 
Keyword;Type;Syntax;Since;Description
@~;Bitwise operator;@~a;4.0;Bitwise unary complement - Bitwise operator
@&;Bitwise operator;a @& b;4.0;Bitwise and AND - Bitwise operator
@^;Bitwise operator;a @^ b;4.0;Bitwise exclusive or XOR - Bitwise operator
@|;Bitwise operator;a @| b;4.0;Bitwise inclusive or OR - Bitwise operator
@<<;Bitwise operator;a @<< b;4.0;Signed left shift - Bitwise operator
@>>;Bitwise operator;a @>> b;4.0;Signed right shift - Bitwise operator

Case 4: Output with no header and ” as text quotation and ; as delimiter + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpCsv = mXparser.getHelpAsCsv("type=Bitwise operator", "\"", ";", false);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpCsv);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...
StringPtr helpCsv = mXparser::getHelpAsCsv("type=Bitwise operator", "\"", ";", false);

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpCsv);
Code result
[mXparser-v.5.2.0] 
"@~";"Bitwise operator";"@~a";"4.0";"Bitwise unary complement - Bitwise operator"
"@&";"Bitwise operator";"a @& b";"4.0";"Bitwise and AND - Bitwise operator"
"@^";"Bitwise operator";"a @^ b";"4.0";"Bitwise exclusive or XOR - Bitwise operator"
"@|";"Bitwise operator";"a @| b";"4.0";"Bitwise inclusive or OR - Bitwise operator"
"@<<";"Bitwise operator";"a @<< b";"4.0";"Signed left shift - Bitwise operator"
"@>>";"Bitwise operator";"a @>> b";"4.0";"Signed right shift - Bitwise operator"
Nuget – Package Manager

Install-Package MathParser.org-mXparser -Version 6.0.0

Nuget – .NET CLI

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

Nuget – Package Reference

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

Maven – Dependency

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

Maven – Gradle

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

CMake – Dependency / FetchContent

include(FetchContent)
FetchContent_Declare(
MathParserOrgMxParser
GIT_REPOSITORY
https://github.com/mariuszgromada/MathParser.org-mXparser.git
SOURCE_SUBDIR
CURRENT/cpp/lib)
FetchContent_MakeAvailable(
MathParserOrgMxParser)
target_link_libraries(YourExecutable
MathParserOrgMxParser)

GitHub

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

OTHER DOWNLOAD OPTIONS

Download latest release – v.6.0.0 Picon: .NET bin onlyDownload latest release – v.6.0.0 Picon: JAVA bin onlyDownload latest release – v.6.0.0 Picon: bin + doc

NEWS FROM MATHPARSER.ORG
SOURCE CODE

Source code .zipSource code .tar.gz
View on GitHubMathSpace.pl

My other creative spaces

DONATION
Did you find the software useful?
Please consider donation 🙂
DONATE