Dentaku

https://rubydoc.info/gems/dentaku
Admin
Dentaku is a Ruby library that provides a safe math expression evaluator and calculator for...
Tokens:103,664
Snippets:869
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### PrintVisitor Initialization

Source: https://rubydoc.info/gems/dentaku/Dentaku/PrintVisitor

Initializes the PrintVisitor with a root node of the AST and starts the traversal process.

```APIDOC
## Initialize PrintVisitor

### Description
Initializes the visitor with an AST node and begins the printing process by accepting the node.

### Method
`initialize(node)`

### Parameters
- **node** (AST Node) - The root node of the Abstract Syntax Tree to be visited.

### Request Example
```ruby
visitor = Dentaku::PrintVisitor.new(ast_root_node)
```

### Response
Initializes the internal `@output` string and calls `accept` on the provided node.
```

--------------------------------

### Initialize Dentaku PrintVisitor

Source: https://rubydoc.info/gems/dentaku/Dentaku/PrintVisitor%3Ainitialize

Initializes the PrintVisitor with a node and starts the traversal. This method is called when creating a new instance of PrintVisitor.

```ruby
def initialize(node)
  @output = ''
  node.accept(self)
end
```

--------------------------------

### POST #match

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatcher

Attempts to match a token stream starting at a specific offset.

```APIDOC
## POST #match

### Description
Matches tokens from the stream against the current matcher constraints.

### Method
POST

### Endpoint
#match(token_stream, offset = 0)

### Parameters
#### Query Parameters
- **token_stream** (Array) - Required - The stream of tokens to evaluate.
- **offset** (Integer) - Optional - The starting index in the stream.

### Response
#### Success Response (200)
- **result** (Array) - Returns [matched (Boolean), matched_tokens (Array)].
```

--------------------------------

### GET Dentaku::MathDomainError#args

Source: https://rubydoc.info/gems/dentaku/Dentaku/MathDomainError%3Aargs

Retrieves the arguments associated with a MathDomainError exception.

```APIDOC
## GET Dentaku::MathDomainError#args

### Description
Returns the value of the 'args' attribute associated with a MathDomainError instance.

### Method
GET

### Response
#### Success Response (200)
- **args** (Object) - The arguments that caused the math domain error.
```

--------------------------------

### Initialize Dentaku::Calculator

Source: https://rubydoc.info/gems/dentaku/Dentaku/Calculator%3Ainitialize

Initializes a new instance of the Dentaku::Calculator, setting up the tokenizer, function registry, and configuration options.

```APIDOC
## Constructor: Dentaku::Calculator#initialize

### Description
Returns a new instance of the Calculator class. This method initializes the internal tokenizer, function registry, and sets configuration options for expression evaluation.

### Parameters
#### Request Body
- **options** (Hash) - Optional - Configuration options for the calculator.
  - **case_sensitive** (Boolean) - Optional - Whether identifiers should be case-sensitive.
  - **aliases** (Hash) - Optional - Custom aliases for functions or variables.
  - **nested_data_support** (Boolean) - Optional - Whether to support nested data structures (default: true).
  - **raw_date_literals** (Boolean) - Optional - Whether to treat date literals as raw values (default: true).

### Request Example
```ruby
calculator = Dentaku::Calculator.new(case_sensitive: false, nested_data_support: true)
```

### Response
#### Success Response (200)
- **instance** (Calculator) - A new instance of the Dentaku::Calculator class.
```

--------------------------------

### GET Dentaku::AST::FunctionRegistry#get

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/FunctionRegistry%3Aget

Retrieves a function from the registry by its name. It checks the current registry and falls back to the default registry if the key is not found.

```APIDOC
## GET Dentaku::AST::FunctionRegistry#get

### Description
Retrieves a function definition from the registry based on the provided name. It first checks the local registry and then the default registry.

### Parameters
#### Path Parameters
- **name** (String/Symbol) - Required - The name of the function to retrieve.

### Response
#### Success Response (200)
- **Object** - The function object if found, otherwise nil.
```

--------------------------------

### Dentaku::PrintVisitor#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/PrintVisitor%3Ainitialize

Initializes a new instance of the PrintVisitor. It takes an AST node as input and accepts the visitor pattern to process the node.

```APIDOC
## POST /websites/rubydoc_info_gems_dentaku/initialize

### Description
Initializes a new instance of the PrintVisitor. It takes an AST node as input and accepts the visitor pattern to process the node.

### Method
POST

### Endpoint
/websites/rubydoc_info_gems_dentaku/initialize

### Parameters
#### Path Parameters
- **node** (Node) - Required - The AST node to be visited.

### Request Body
```json
{
  "node": { ... AST Node structure ... }
}
```

### Response
#### Success Response (200)
- **PrintVisitor** (PrintVisitor) - A new instance of the PrintVisitor.

#### Response Example
```json
{
  "message": "PrintVisitor initialized successfully"
}
```
```

--------------------------------

### GET function_name

Source: https://rubydoc.info/gems/dentaku/Dentaku/MathDomainError

Retrieves the value of the function_name attribute.

```APIDOC
## GET function_name

### Description
Returns the value of the function_name attribute.

### Method
GET

### Response
#### Success Response (200)
- **function_name** (Object) - The value of the function_name attribute.
```

--------------------------------

### Get case_sensitive attribute

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenScanner

Returns the current case_sensitive attribute value.

```ruby
# File 'lib/dentaku/token_scanner.rb', line 33

def case_sensitive
  @case_sensitive
end
```

--------------------------------

### Dentaku::AST::CaseElse#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/CaseElse%3Ainitialize

Initializes a new instance of the CaseElse AST node.

```APIDOC
## initialize

### Description
Returns a new instance of CaseElse.

### Parameters
#### Request Body
- **node** (Object) - Required - The node to be assigned to the CaseElse instance.

### Response
#### Success Response (200)
- **CaseElse** (Object) - A new instance of the CaseElse class.
```

--------------------------------

### GET /exceptions/ZeroDivisionError/recipient_variable

Source: https://rubydoc.info/gems/dentaku/Dentaku/ZeroDivisionError%3Arecipient_variable

Retrieves the recipient variable associated with a ZeroDivisionError exception.

```APIDOC
## GET /exceptions/ZeroDivisionError/recipient_variable

### Description
Returns the value of the recipient_variable attribute for a ZeroDivisionError instance.

### Method
GET

### Endpoint
/exceptions/ZeroDivisionError/recipient_variable

### Response
#### Success Response (200)
- **recipient_variable** (Object) - The variable that caused the division by zero error.

#### Response Example
{
  "recipient_variable": "x"
}
```

--------------------------------

### Constructor: initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/Parser

Initializes a new Parser instance with tokens and configuration options.

```APIDOC
## initialize(tokens, options = {})

### Description
Creates a new instance of the Parser class.

### Parameters
#### Request Body
- **tokens** (Array) - Required - The list of tokens to parse.
- **options** (Hash) - Optional - Configuration options including :operations, :arities, :function_registry, and :case_sensitive.
```

--------------------------------

### Dentaku::AST::CaseThen#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/CaseThen%3Ainitialize

Initializes a new instance of the CaseThen AST node.

```APIDOC
## Dentaku::AST::CaseThen#initialize

### Description
Initializes a new instance of the CaseThen AST node.

### Method
initialize

### Endpoint
N/A (Instance method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
# This is a Ruby method, not an API endpoint.
# Example usage would be within the Dentaku parsing/evaluation context.
```

### Response
#### Success Response (200)
N/A (Instance method returns an object)

#### Response Example
```ruby
# Returns an instance of Dentaku::AST::CaseThen
```
```

--------------------------------

### GET /matcher

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatchers

Retrieves a single specific token matcher by its symbol.

```APIDOC
## GET /matcher

### Description
Fetches a specific token matcher by its unique symbol identifier.

### Method
GET

### Endpoint
/matcher

### Parameters
#### Query Parameters
- **symbol** (Symbol) - Required - The identifier for the specific token matcher (e.g., :datetime, :numeric, :comparator).

### Response
#### Success Response (200)
- **matcher** (Object) - The requested token matcher object.

### Error Handling
- Raises an error if the symbol does not exist in the internal matcher registry.
```

--------------------------------

### Dentaku::Visitor::Infix Instance Methods

Source: https://rubydoc.info/gems/dentaku/Dentaku/Visitor/Infix

This section details the instance methods available in the Dentaku::Visitor::Infix module, including their purpose and any exceptions they might raise.

```APIDOC
## Dentaku::Visitor::Infix Instance Methods

### Description
Provides an overview of the instance methods within the `Dentaku::Visitor::Infix` module.

### Method
`process(_ast)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.process(ast_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "processed_ast_representation"
}
```

### Error Handling
- **NotImplementedError**: Raised by the `process` method.

---

### Method
`visit(ast)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit(ast_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "visited_ast_representation"
}
```

### Error Handling
None explicitly mentioned for `visit`.

---

### Method
`visit_access(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_access(access_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "access_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_array(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_array(array_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "array_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_case(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_case(case_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "case_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_case_conditional(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_case_conditional(case_conditional_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "case_conditional_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_else(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_else(else_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "else_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_function(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_function(function_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "function_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_identifier(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_identifier(identifier_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "identifier_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_literal(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_literal(literal_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "literal_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_negation(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_negation(negation_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "negation_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_nil(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_nil(nil_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "nil_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_operand(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_operand(operand_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "operand_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_operation(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_operation(operation_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "operation_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_switch(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_switch(switch_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "switch_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_then(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_then(then_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "then_node_representation"
}
```

### Error Handling
None explicitly mentioned.

---

### Method
`visit_when(node)`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
visitor = Dentaku::Visitor::Infix.new
visitor.visit_when(when_node)
```

### Response
#### Success Response (200)
Returns `Object` (specific return type depends on implementation).

#### Response Example
```json
{
  "result": "when_node_representation"
}
```

### Error Handling
None explicitly mentioned.
```

--------------------------------

### GET /Dentaku/ArgumentError/meta

Source: https://rubydoc.info/gems/dentaku/Dentaku/ArgumentError%3Ameta

Retrieves the meta attribute associated with a Dentaku ArgumentError.

```APIDOC
## GET /Dentaku/ArgumentError/meta

### Description
Returns the value of the meta attribute for a given ArgumentError instance within the Dentaku library.

### Method
GET

### Endpoint
/Dentaku/ArgumentError/meta

### Response
#### Success Response (200)
- **meta** (Object) - The metadata associated with the argument error.
```

--------------------------------

### GET #leaf_matchers

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatcher

Retrieves the list of leaf matchers associated with the current node.

```APIDOC
## GET #leaf_matchers

### Description
Returns an array containing the current object if it is a leaf, or its children if it is not.

### Method
GET

### Endpoint
#leaf_matchers

### Response
- **result** (Array) - A list of leaf matchers.
```

--------------------------------

### Dentaku::ArgumentError#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/ArgumentError%3Ainitialize

Initializes a new instance of Dentaku::ArgumentError with a reason and optional metadata.

```APIDOC
## Dentaku::ArgumentError#initialize

### Description
Returns a new instance of ArgumentError.

### Method
initialize

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a new instance of ArgumentError.

#### Response Example
None
```

--------------------------------

### GET #leaf_matcher?

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatcher

Checks if the current matcher is a leaf node by verifying if it has no children.

```APIDOC
## GET #leaf_matcher?

### Description
Returns true if the matcher has no children, indicating it is a leaf node.

### Method
GET

### Endpoint
#leaf_matcher?

### Response
- **result** (Boolean) - True if children are empty, false otherwise.
```

--------------------------------

### Initialize Parser

Source: https://rubydoc.info/gems/dentaku/Dentaku/Parser

Creates a new instance of the Parser with tokens and optional configuration.

```ruby
# File 'lib/dentaku/parser.rb', line 33

def initialize(tokens, options = {})
  @input             = tokens.dup
  @output            = []
  @operations        = options.fetch(:operations, [])
  @arities           = options.fetch(:arities, [])
  @function_registry = options.fetch(:function_registry, nil)
  @case_sensitive    = options.fetch(:case_sensitive, false)
  @skip_indices      = []
end
```

--------------------------------

### GET Dentaku::AST::Negation#dependencies

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Negation%3Adependencies

Retrieves the dependencies for a negation node within the Dentaku AST.

```APIDOC
## GET Dentaku::AST::Negation#dependencies

### Description
Returns the dependencies of the node being negated by delegating to the underlying node's dependencies method.

### Method
GET

### Parameters
#### Query Parameters
- **context** (Hash) - Optional - A context object used to resolve dependencies, defaults to an empty hash.

### Response
#### Success Response (200)
- **dependencies** (Object) - The list of dependencies found for the node.
```

--------------------------------

### GET /token_matchers

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatchers

Retrieves a list of token matchers based on the provided symbols.

```APIDOC
## GET /token_matchers

### Description
Retrieves one or more token matchers based on the provided symbols.

### Method
GET

### Endpoint
/token_matchers

### Parameters
#### Query Parameters
- **symbols** (Array) - Required - A list of symbols representing the token matchers to retrieve (e.g., :numeric, :string, :addsub).

### Response
#### Success Response (200)
- **matchers** (Array) - A collection of token matcher objects corresponding to the requested symbols.

### Error Handling
- Raises an error if an unknown token symbol is requested.
```

--------------------------------

### GET Dentaku::AST::Duration#dependencies

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Duration%3Adependencies

Retrieves the dependencies for a duration node within a given context.

```APIDOC
## GET Dentaku::AST::Duration#dependencies

### Description
Returns the dependencies of the first argument (value_node) within the provided context for a duration AST node.

### Method
GET

### Parameters
#### Query Parameters
- **context** (Hash) - Optional - A hash representing the evaluation context containing variable bindings.

### Response
#### Success Response (200)
- **dependencies** (Object) - The list of dependencies required to evaluate the duration node.
```

--------------------------------

### GET Dentaku::TokenMatcher#children

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenMatcher%3Achildren

Retrieves the children attribute from the TokenMatcher class.

```APIDOC
## GET Dentaku::TokenMatcher#children

### Description
Returns the value of the children attribute for a TokenMatcher instance.

### Method
GET

### Endpoint
lib/dentaku/token_matcher.rb

### Response
#### Success Response (200)
- **children** (Object) - The value of the children attribute.
```

--------------------------------

### Dentaku::AST::CaseWhen#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/CaseWhen%3Ainitialize

Initializes a new instance of the CaseWhen AST node.

```APIDOC
## initialize(node)

### Description
Returns a new instance of CaseWhen.

### Parameters
#### Request Body
- **node** (Object) - Required - The node associated with the CaseWhen condition.

### Response
#### Success Response (200)
- **instance** (CaseWhen) - A new instance of the CaseWhen class.
```

--------------------------------

### Initialize Dentaku Calculator

Source: https://rubydoc.info/gems/dentaku/Dentaku/Calculator%3Ainitialize

Initializes a new Calculator instance with optional configuration settings for case sensitivity, aliases, and data support.

```ruby
def initialize(options = {})
  clear
  @tokenizer = Tokenizer.new
  @case_sensitive = options.delete(:case_sensitive)
  @aliases = options.delete(:aliases) || Dentaku.aliases
  @nested_data_support = options.fetch(:nested_data_support, true)
  options.delete(:nested_data_support)
  @raw_date_literals = options.fetch(:raw_date_literals, true)
  options.delete(:raw_date_literals)
  @ast_cache = options
  @disable_ast_cache = false
  @function_registry = Dentaku::AST::FunctionRegistry.new
end
```

--------------------------------

### Dentaku::AST::StringFunctions::Substitute#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/StringFunctions/Substitute%3Ainitialize

Initializes a new instance of the Substitute function, setting the original string, the search string, and the replacement string.

```APIDOC
## POST /ast/string_functions/substitute

### Description
Initializes a new instance of the Substitute function. This function is used to replace occurrences of a substring within a given string.

### Method
POST

### Endpoint
/ast/string_functions/substitute

### Parameters
#### Request Body
- **original** (string) - Required - The original string in which to perform replacements.
- **search** (string) - Required - The substring to search for within the original string.
- **replacement** (string) - Required - The string to replace the found occurrences with.

### Request Example
```json
{
  "original": "hello world",
  "search": "world",
  "replacement": "Dentaku"
}
```

### Response
#### Success Response (200)
- **Substitute** (object) - A new instance of the Substitute class.

#### Response Example
```json
{
  "Substitute": {
    "original": "hello Dentaku",
    "search": "world",
    "replacement": "Dentaku"
  }
}
```
```

--------------------------------

### Get Scanners

Source: https://rubydoc.info/gems/dentaku/Dentaku/TokenScanner

Retrieves the currently registered scanners, with an option to exclude date literals.

```ruby
def scanners(options = {})
  @case_sensitive = options.fetch(:case_sensitive, false)
  raw_date_literals = options.fetch(:raw_date_literals, true)

  @scanners.select { |k, _| raw_date_literals || k != :datetime }.values
end
```

--------------------------------

### GET Dentaku::AST::Access#dependencies

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Access%3Adependencies

Retrieves the dependencies for an AST Access node by combining dependencies from the structure and the index.

```APIDOC
## GET Dentaku::AST::Access#dependencies

### Description
Calculates and returns the dependencies for an AST Access node. It aggregates dependencies from both the structure and the index components.

### Method
GET

### Parameters
#### Query Parameters
- **context** (Hash) - Optional - A context object used to resolve dependencies, defaulting to an empty hash.

### Response
#### Success Response (200)
- **dependencies** (Object) - The combined dependencies of the structure and index.
```

--------------------------------

### Token Length and String Representation

Source: https://rubydoc.info/gems/dentaku/Dentaku/Token

Methods to get the length and string representation of a token.

```APIDOC
## GET /websites/rubydoc_info_gems_dentaku/token/length

### Description
Returns the length of the token's raw value.

### Method
GET

### Endpoint
/websites/rubydoc_info_gems_dentaku/token/length

### Response
#### Success Response (200)
- **length** (Integer) - The length of the token's raw value.
```

```APIDOC
## GET /websites/rubydoc_info_gems_dentaku/token/to_s

### Description
Returns the string representation of the token, prioritizing raw_value.

### Method
GET

### Endpoint
/websites/rubydoc_info_gems_dentaku/token/to_s

### Response
#### Success Response (200)
- **string_representation** (String) - The string representation of the token.
```

--------------------------------

### Dentaku::PrintVisitor Constructor

Source: https://rubydoc.info/gems/dentaku/Dentaku/PrintVisitor

Initializes a new instance of the PrintVisitor class with a specific AST node.

```APIDOC
## Constructor: initialize

### Description
Creates a new instance of the PrintVisitor class to process the provided AST node.

### Parameters
- **node** (Object) - Required - The AST node to be visited and printed.
```

--------------------------------

### Dentaku::AST::StringFunctions::Right#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/StringFunctions/Right%3Ainitialize

Initializes a new instance of the Right class, which is part of Dentaku's AST String Functions.

```APIDOC
## Dentaku::AST::StringFunctions::Right#initialize

### Description
Initializes a new instance of the Right class.

### Method
initialize

### Endpoint
N/A (Class Initialization)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
Right.new("example_string", 5)
```

### Response
#### Success Response (200)
Returns a new instance of Right.

#### Response Example
```ruby
#<Dentaku::AST::StringFunctions::Right @string="example_string", @length=5>
```
```

--------------------------------

### GET Dentaku::Token#length

Source: https://rubydoc.info/gems/dentaku/Dentaku/Token%3Alength

Retrieves the length of the raw value associated with a token.

```APIDOC
## GET Dentaku::Token#length

### Description
Returns the length of the string representation of the token's raw value.

### Method
GET

### Response
#### Success Response (200)
- **length** (Integer) - The character count of the raw value.
```

--------------------------------

### Dentaku::ParseError#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/ParseError%3Ainitialize

Initializes a new instance of the ParseError class.

```APIDOC
## Dentaku::ParseError#initialize

### Description
Initializes a new instance of the ParseError class.

### Method
initialize

### Endpoint
N/A (Instance method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
Returns a new instance of ParseError.

#### Response Example
None
```

--------------------------------

### GET Dentaku::NodeError#expect

Source: https://rubydoc.info/gems/dentaku/Dentaku/NodeError%3Aexpect

Retrieves the expected value attribute from a NodeError instance.

```APIDOC
## GET Dentaku::NodeError#expect

### Description
Returns the value of the 'expect' attribute associated with a NodeError, which indicates the expected state or value that caused the error.

### Method
GET

### Endpoint
Dentaku::NodeError#expect

### Response
#### Success Response (200)
- **expect** (Object) - The value of the attribute.
```

--------------------------------

### GET Dentaku::AST::Node#dependencies

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Node%3Adependencies

Retrieves the list of dependencies for a given AST node, optionally filtered by a provided context.

```APIDOC
## GET Dentaku::AST::Node#dependencies

### Description
Returns the dependencies required by the AST node. By default, this returns an empty array, but it is intended to be overridden by subclasses to identify variables needed for evaluation.

### Method
GET

### Parameters
#### Query Parameters
- **context** (Hash) - Optional - A hash containing current variable bindings or evaluation context.

### Response
#### Success Response (200)
- **dependencies** (Array) - A list of identifiers or nodes that the current node depends on.
```

--------------------------------

### GET Dentaku::Calculator#aliases

Source: https://rubydoc.info/gems/dentaku/Dentaku/Calculator%3Aaliases

Retrieves the aliases attribute from the Dentaku::Calculator instance.

```APIDOC
## GET Dentaku::Calculator#aliases

### Description
Returns the value of the aliases attribute associated with the calculator instance.

### Method
GET

### Endpoint
Dentaku::Calculator#aliases

### Response
#### Success Response (200)
- **aliases** (Object) - The current aliases configuration for the calculator.
```

--------------------------------

### Dentaku::AST::StringFunctions::Mid#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/StringFunctions/Mid%3Ainitialize

Initializes a new instance of the Mid class, which is part of Dentaku's AST String Functions. It takes a string, an offset, and a length as arguments.

```APIDOC
## POST /ast/string_functions/mid/initialize

### Description
Initializes a new instance of the Mid class.

### Method
POST

### Endpoint
/ast/string_functions/mid/initialize

### Parameters
#### Request Body
- **string** (string) - Required - The input string.
- **offset** (integer) - Required - The starting position for the substring.
- **length** (integer) - Required - The length of the substring to extract.

### Request Example
{
  "string": "example string",
  "offset": 3,
  "length": 5
}

### Response
#### Success Response (200)
- **Mid** (object) - A new instance of the Mid class.

#### Response Example
{
  "Mid": {
    "string": "example string",
    "offset": 3,
    "length": 5
  }
}
```

--------------------------------

### GET Dentaku::AST::Function#dependencies

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Function%3Adependencies

Retrieves the dependencies for a given AST function within a specific context.

```APIDOC
## GET Dentaku::AST::Function#dependencies

### Description
Returns the dependencies of the function by iterating through its arguments and collecting their dependencies.

### Method
GET

### Parameters
#### Query Parameters
- **context** (Hash) - Optional - A hash representing the current evaluation context, defaulting to an empty hash.

### Response
#### Success Response (200)
- **dependencies** (Array) - A list of dependencies identified within the function arguments.
```

--------------------------------

### Initialize Dentaku::AST::Access

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Access%3Ainitialize

Initializes a new instance of the Access class. It takes a data structure and an index as arguments.

```ruby
def initialize(data_structure, index)
  @structure = data_structure
  @index = index
end
```

--------------------------------

### GET Dentaku::AST::If#predicate

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/If%3Apredicate

Retrieves the predicate attribute from the If AST node.

```APIDOC
## GET Dentaku::AST::If#predicate

### Description
Returns the value of the predicate attribute for the If function node in the AST.

### Method
GET

### Endpoint
Dentaku::AST::If#predicate

### Response
#### Success Response (200)
- **predicate** (Object) - The predicate value associated with the If node.
```

--------------------------------

### GET Dentaku::AST::FunctionRegistry#default

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/FunctionRegistry%3Adefault

Retrieves the default function registry configuration.

```APIDOC
## GET Dentaku::AST::FunctionRegistry#default

### Description
Returns the default function registry instance used by the Dentaku AST.

### Method
GET

### Endpoint
Dentaku::AST::FunctionRegistry#default

### Response
#### Success Response (200)
- **result** (Object) - The default function registry object.
```

--------------------------------

### Dentaku::AST::Reduce#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Reduce%3Ainitialize

Initializes a new instance of the Reduce class, validating the provided arguments.

```APIDOC
## initialize(*args)

### Description
Returns a new instance of the Reduce class. It performs validation on the second and third arguments to ensure they are valid identifiers.

### Parameters
- **args** (Array) - Required - A list of arguments passed to the initializer.

### Response
- **Reduce** (Object) - A new instance of the Reduce class.

### Code Example
```ruby
def initialize(*args)
  super

  validate_identifier(@args[1], 'second')
  validate_identifier(@args[2], 'third')
end
```
```

--------------------------------

### Dentaku::MathDomainError#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/MathDomainError%3Ainitialize

Initializes a new instance of MathDomainError with the given function name and arguments.

```APIDOC
## Dentaku::MathDomainError#initialize

### Description
Returns a new instance of MathDomainError.

### Method
initialize

### Parameters
- **function_name** (any) - Required - The name of the function that caused the error.
- **args** (any) - Required - The arguments passed to the function.

### Endpoint
N/A (Instance method)

### Request Example
N/A

### Response
#### Success Response (200)
- **MathDomainError** (Object) - A new instance of the MathDomainError class.

#### Response Example
```ruby
error = Dentaku::MathDomainError.new('sqrt', [-1])
```
```

--------------------------------

### GET Dentaku::AST::Comparator.precedence

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Comparator.precedence

Retrieves the precedence level for the Comparator AST node.

```APIDOC
## GET Dentaku::AST::Comparator.precedence

### Description
Returns the precedence value for the Comparator class within the Dentaku AST.

### Method
GET

### Endpoint
Dentaku::AST::Comparator.precedence

### Response
#### Success Response (200)
- **precedence** (Integer) - The precedence level, which is 5.
```

--------------------------------

### GET Dentaku::AST::Function#args

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Function%3Aargs

Retrieves the arguments associated with a function node in the Dentaku Abstract Syntax Tree.

```APIDOC
## GET Dentaku::AST::Function#args

### Description
Returns the value of the 'args' attribute for a given function node within the Dentaku AST.

### Method
GET

### Endpoint
Dentaku::AST::Function#args

### Response
#### Success Response (200)
- **args** (Object) - The arguments associated with the function node.
```

--------------------------------

### GET Dentaku::AST::Access#type

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Access%3Atype

Retrieves the type of the AST Access node.

```APIDOC
## GET Dentaku::AST::Access#type

### Description
Returns the type associated with the AST Access node. Currently, this method returns nil.

### Method
GET

### Response
#### Success Response (200)
- **type** (Object) - Returns nil.
```

--------------------------------

### Dentaku::AST::Grouping Class Documentation

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Grouping

Documentation for the Dentaku::AST::Grouping class, including its constructor and instance methods.

```APIDOC
## Class: Dentaku::AST::Grouping

Inherits:
     Node
  * Object
  * Node
  * Dentaku::AST::Grouping

show all 

Defined in:
    lib/dentaku/ast/grouping.rb
##  Instance Method Summary collapse
  * #**dependencies**(context = {}) ⇒ Object 
  * #**initialize**(node) ⇒ Grouping  constructor
A new instance of Grouping.
  * #**type** ⇒ Object 
  * #**value**(context = {}) ⇒ Object 


### Methods inherited from Node
arity, #name, precedence, resolve_class
## Constructor Details
### permalink #**initialize**(node) ⇒ `Grouping`
Returns a new instance of Grouping.
[View source] 
```ruby
# File 'lib/dentaku/ast/grouping.rb', line 6

def initialize(node)
  @node = node
end
```
```

```APIDOC
## Instance Method Details
### permalink #**dependencies**(context = {}) ⇒ `Object`
[View source] 
```ruby
# File 'lib/dentaku/ast/grouping.rb', line 18

def dependencies(context = {})
  @node.dependencies(context)
end
```
### permalink #**type** ⇒ `Object`
[View source] 
```ruby
# File 'lib/dentaku/ast/grouping.rb', line 14

def type
  @node.type
end
```
```

--------------------------------

### Tokenize input string

Source: https://rubydoc.info/gems/dentaku/Dentaku/Tokenizer

Main entry point to convert a string into a list of tokens, applying aliases and stripping comments.

```ruby
# File 'lib/dentaku/tokenizer.rb', line 12

def tokenize(string, options = {})
  @nesting = 0
  @tokens  = []
  @aliases = options.fetch(:aliases, global_aliases)
  input    = strip_comments(string.to_s.dup)
  input    = replace_aliases(input)

  scanner_options = {
    case_sensitive: options.fetch(:case_sensitive, false),
    raw_date_literals: options.fetch(:raw_date_literals, true)
  }

  until input.empty?
    scanned = TokenScanner.scanners(scanner_options).any? do |scanner|
      scanned, input = scan(input, scanner)
      scanned
    end

    unless scanned
      fail! :parse_error, at: input
    end
  end

  fail! :too_many_opening_parentheses if @nesting > 0

  @tokens
end
```

--------------------------------

### Initialize Dentaku::AST::Array

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Array%3Ainitialize

Constructor for creating a new instance of the Array AST node.

```ruby
# File 'lib/dentaku/ast/array.rb', line 17

def initialize(*elements)
  @elements = *elements
end
```

--------------------------------

### GET Dentaku::Calculator#memory

Source: https://rubydoc.info/gems/dentaku/Dentaku/Calculator%3Amemory

Retrieves the current memory state of the Dentaku calculator instance.

```APIDOC
## GET Dentaku::Calculator#memory

### Description
Returns the current value stored in the calculator's memory attribute.

### Method
GET

### Response
#### Success Response (200)
- **memory** (Object) - The current value of the calculator memory.
```

--------------------------------

### Dentaku::AST::Function#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Function%3Ainitialize

Details the initialization method for the Dentaku AST Function class.

```APIDOC
## Dentaku::AST::Function#initialize

### Description
Initializes a new instance of the `Function` class with the provided arguments.

### Method
`initialize(*args)`

### Endpoint
N/A (Class method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```ruby
Dentaku::AST::Function.new(arg1, arg2)
```

### Response
#### Success Response (200)
Returns a new instance of `Function`.

#### Response Example
```ruby
#<Dentaku::AST::Function:0x00007f8d3e9b7a00 @args=["arg1", "arg2"]>
```
```

--------------------------------

### GET Dentaku::BulkExpressionSolver.dependency_cache

Source: https://rubydoc.info/gems/dentaku/Dentaku/BulkExpressionSolver.dependency_cache

Retrieves the internal dependency cache used by the BulkExpressionSolver for expression evaluation.

```APIDOC
## GET Dentaku::BulkExpressionSolver.dependency_cache

### Description
Returns the current dependency cache hash used by the BulkExpressionSolver. If the cache has not been initialized, it initializes an empty hash.

### Method
GET

### Endpoint
Dentaku::BulkExpressionSolver.dependency_cache

### Response
#### Success Response (200)
- **@dep_cache** (Hash) - The internal dependency cache object.
```

--------------------------------

### GET Dentaku::AST::Or#operator

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Or%3Aoperator

Retrieves the operator symbol for the logical OR AST node.

```APIDOC
## GET Dentaku::AST::Or#operator

### Description
Returns the operator symbol associated with the logical OR operation within the Dentaku AST.

### Method
GET

### Response
#### Success Response (200)
- **operator** (Symbol) - The symbol :or
```

--------------------------------

### Dentaku::Token#initialize

Source: https://rubydoc.info/gems/dentaku/Dentaku/Token%3Ainitialize

Initializes a new Dentaku::Token object. The constructor accepts a category, a value, and an optional raw_value.

```APIDOC
## Dentaku::Token#initialize

### Description
Initializes a new instance of Token.

### Method
initialize

### Parameters
- **category** (type) - Required - Description of the token's category.
- **value** (type) - Required - The processed value of the token.
- **raw_value** (type) - Optional - The original, unprocessed value of the token.

### Request Example
```ruby
Dentaku::Token.new(:numeric, 123, "123")
```

### Response
#### Success Response (200)
- **Token** (object) - A new instance of the Token class.
```

--------------------------------

### GET Dentaku::AST::NotEqual#operator

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/NotEqual%3Aoperator

Retrieves the operator symbol for the NotEqual AST node.

```APIDOC
## GET Dentaku::AST::NotEqual#operator

### Description
Returns the symbol representing the 'not equal' operator used in the Dentaku AST.

### Method
GET

### Response
#### Success Response (200)
- **operator** (Symbol) - The symbol :!= representing the not equal operation.
```

--------------------------------

### Implement Process Method

Source: https://rubydoc.info/gems/dentaku/Dentaku/Visitor/Infix

The 'process' method in Dentaku::Visitor::Infix is intended to be overridden by subclasses. It raises a NotImplementedError if called directly.

```ruby
def process(_ast)
  raise NotImplementedError
end
```

--------------------------------

### Initialize Dentaku::ArgumentError

Source: https://rubydoc.info/gems/dentaku/Dentaku/ArgumentError%3Ainitialize

Creates a new instance of ArgumentError with a reason and optional metadata.

```ruby
def initialize(reason, **meta)
  @reason = reason
  @meta = meta
end
```

--------------------------------

### GET Dentaku::AST::Modulo.precedence

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Modulo.precedence

Retrieves the precedence value for the Modulo operation in the Dentaku AST.

```APIDOC
## GET Dentaku::AST::Modulo.precedence

### Description
Returns the precedence level of the modulo operation, which is used by the parser to determine the order of operations.

### Method
GET

### Response
#### Success Response (200)
- **precedence** (Integer) - The precedence value, which is 20.
```

--------------------------------

### GET Dentaku::AST::LessThan#operator

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/LessThan%3Aoperator

Retrieves the operator symbol for the LessThan AST node.

```APIDOC
## GET Dentaku::AST::LessThan#operator

### Description
Returns the operator symbol used by the LessThan comparison node.

### Method
GET

### Response
#### Success Response (200)
- **operator** (Object) - The symbol :< representing the less than operator.
```

--------------------------------

### Initialize Reduce AST node

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Reduce%3Ainitialize

Initializes a new Reduce instance and validates the second and third arguments as identifiers.

```ruby
def initialize(*args)
  super

  validate_identifier(@args[1], 'second')
  validate_identifier(@args[2], 'third')
end
```

--------------------------------

### Dentaku::AST::Map Class Documentation

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/Map

Detailed documentation for the Dentaku::AST::Map class, including its inheritance hierarchy, instance attributes, and instance methods.

```APIDOC
## Class: Dentaku::AST::Map

### Inheritance
This class inherits from `Enum` and its ancestors include `Object`, `Node`, `Function`, `Enum`, and `Dentaku::AST::Map`.

### Defined in
`lib/dentaku/ast/functions/map.rb`

### Constant Summary
#### Constants inherited from Function
- `DIG`

### Instance Attribute Summary
#### Attributes inherited from Function
- `#args`

### Instance Method Summary
#### Methods inherited from Enum
- `#dependencies`
- `#initialize`
- `max_param_count`
- `min_param_count`
- `#validate_identifier`

#### Methods inherited from Function
- `#accept`
- `#dependencies`
- `get`
- `#initialize`
- `numeric`
- `register`
- `register_class`
- `registry`

#### Methods inherited from Node
- `arity`
- `#dependencies`
- `#name`
- `precedence`
- `resolve_class`
- `#type`

### Constructor Details
This class inherits its constructor from `Dentaku::AST::Enum`.

### Instance Method Details
#### permalink #**value**(context = {}) ⇒ `Object`
[View source]
```ruby
# ... (source code for value method)
```
```

--------------------------------

### GET /Dentaku/AST/If#right

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/If%3Aright

Retrieves the 'right' attribute value from an If conditional node in the Dentaku AST.

```APIDOC
## GET /Dentaku/AST/If#right

### Description
Returns the value of the 'right' attribute for an If conditional node, which represents the expression evaluated when the condition is false.

### Method
GET

### Endpoint
Dentaku::AST::If#right

### Response
#### Success Response (200)
- **right** (Object) - The value of the right attribute.
```

--------------------------------

### Implement accept method for CaseElse

Source: https://rubydoc.info/gems/dentaku/Dentaku/AST/CaseElse%3Aaccept

The accept method is used to trigger the visitor pattern for the CaseElse node.

```ruby
def accept(visitor)
  visitor.visit_else(self)
end
```
Tokens:
Raw