Exporting help in the JSON format

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

// Only built-in elements
StringPtr mXparser::getHelpAsJson();
StringPtr mXparser::getHelpAsJson(const std::string &query);
StringPtr mXparser::getHelpAsJson(bool addCaption, const std::string &caption);
StringPtr mXparser::getHelpAsJson(
      const std::string &query
      ,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->getHelpAsJson();
StringPtr e->getHelpAsJson(const std::string &query);
StringPtr e->getHelpAsJson(bool addCaption, const std::string &caption);
StringPtr e->getHelpAsJson(
      const std::string &query
      ,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 standard caption + advanced search

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

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

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

Case 2: Output with user caption + advanced search

Java/C# code
// JAVA: import org.mariuszgromada.math.mxparser.*;
// C#: using org.mariuszgromada.math.mxparser;
// ...
String helpJson = mXparser.getHelpAsJson(
		"type=Bitwise operator"
		,true
		,"This is a caption"
);

mXparser.consolePrint("\n");
mXparser.consolePrintln(helpJson);
C++ code
#include "org/mariuszgromada/math/mxparser.hpp"
// ...

StringPtr helpJson = mXparser::getHelpAsJson(
        "type=Bitwise operator"
        ,true
        ,"This is a caption"
);

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

Case 3: Output with no caption + advanced search

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

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

mXparser::consolePrint("\n");
mXparser::consolePrintln(helpJson);
Code result
[mXparser-v.5.2.0] 
[
  {
    "Keyword": "@~",
    "Type": "Bitwise operator",
    "Syntax": "@~a",
    "Since": "4.0",
    "Description": "Bitwise unary complement - Bitwise operator"
  },
  {
    "Keyword": "@&",
    "Type": "Bitwise operator",
    "Syntax": "a @& b",
    "Since": "4.0",
    "Description": "Bitwise and AND - Bitwise operator"
  },
  {
    "Keyword": "@^",
    "Type": "Bitwise operator",
    "Syntax": "a @^ b",
    "Since": "4.0",
    "Description": "Bitwise exclusive or XOR - Bitwise operator"
  },
  {
    "Keyword": "@|",
    "Type": "Bitwise operator",
    "Syntax": "a @| b",
    "Since": "4.0",
    "Description": "Bitwise inclusive or OR - Bitwise operator"
  },
  {
    "Keyword": "@<<",
    "Type": "Bitwise operator",
    "Syntax": "a @<< b",
    "Since": "4.0",
    "Description": "Signed left shift - Bitwise operator"
  },
  {
    "Keyword": "@>>",
    "Type": "Bitwise operator",
    "Syntax": "a @>> b",
    "Since": "4.0",
    "Description": "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
Donation with PayPal