Notation used in Ruby API documentation
Module: db
Description: This class represents the metrics type for \Region#width and related checks.
This class is equivalent to the class Region::Metrics
This enum has been introduced in version 0.27.
new Region::Metrics ptr | new | (int i) | Creates an enum from an integer value |
new Region::Metrics ptr | new | (string s) | Creates an enum from a string value |
[const] | bool | != | (const Region::Metrics other) | Compares two enums for inequality |
[const] | bool | != | (int other) | Compares an enum with an integer for inequality |
[const] | bool | < | (const Region::Metrics other) | Returns true if the first enum is less (in the enum symbol order) than the second |
[const] | bool | < | (int other) | Returns true if the enum is less (in the enum symbol order) than the integer value |
[const] | bool | == | (const Region::Metrics other) | Compares two enums |
[const] | bool | == | (int other) | Compares an enum with an integer value |
[const] | string | inspect | Converts an enum to a visual string | |
[const] | int | to_i | Gets the integer value from the enum | |
[const] | string | to_s | Gets the symbolic string from an enum |
[static,const] | Region::Metrics | Euclidian | Specifies Euclidian metrics for the check functions | |
[static,const] | Region::Metrics | Projection | Specifies projected distance metrics for the check functions | |
[static,const] | Region::Metrics | Square | Specifies square metrics for the check functions |
!= | (1) Signature: [const] bool != (const Region::Metrics other) Description: Compares two enums for inequality |
(2) Signature: [const] bool != (int other) Description: Compares an enum with an integer for inequality | |
< | (1) Signature: [const] bool < (const Region::Metrics other) Description: Returns true if the first enum is less (in the enum symbol order) than the second |
(2) Signature: [const] bool < (int other) Description: Returns true if the enum is less (in the enum symbol order) than the integer value | |
== | (1) Signature: [const] bool == (const Region::Metrics other) Description: Compares two enums |
(2) Signature: [const] bool == (int other) Description: Compares an enum with an integer value | |
Euclidian | Signature: [static,const] Region::Metrics Euclidian Description: Specifies Euclidian metrics for the check functions This value can be used for the metrics parameter in the check functions, i.e. width_check. This value specifies Euclidian metrics, i.e. the distance between two points is measured by: d = sqrt(dx^2 + dy^2) All points within a circle with radius d around one point are considered to have a smaller distance than d. Python specific notes: |
Projection | Signature: [static,const] Region::Metrics Projection Description: Specifies projected distance metrics for the check functions This value can be used for the metrics parameter in the check functions, i.e. width_check. This value specifies projected metrics, i.e. the distance is defined as the minimum distance measured perpendicular to one edge. That implies that the distance is defined only where two edges have a non-vanishing projection onto each other. Python specific notes: |
Square | Signature: [static,const] Region::Metrics Square Description: Specifies square metrics for the check functions This value can be used for the metrics parameter in the check functions, i.e. width_check. This value specifies square metrics, i.e. the distance between two points is measured by: d = max(abs(dx), abs(dy)) All points within a square with length 2*d around one point are considered to have a smaller distance than d in this metrics. Python specific notes: |
inspect | Signature: [const] string inspect Description: Converts an enum to a visual string Python specific notes: |
new | (1) Signature: [static] new Region::Metrics ptr new (int i) Description: Creates an enum from an integer value Python specific notes: |
(2) Signature: [static] new Region::Metrics ptr new (string s) Description: Creates an enum from a string value Python specific notes: | |
to_i | Signature: [const] int to_i Description: Gets the integer value from the enum |
to_s | Signature: [const] string to_s Description: Gets the symbolic string from an enum Python specific notes: |