Notation used in Ruby API documentation
Module: db
Description: A integer vector class
A vector is a distance in cartesian, 2 dimensional space. A vector is given by two coordinates (x and y) and represents the distance between two points. Being the distance, transformations act differently on vectors: the displacement is not applied. Vectors are not geometrical objects by itself. But they are frequently used in the database API for various purposes.
This class has been introduced in version 0.25.
See The Database API for more details about the database objects.
| new Vector ptr | new | (const DVector dvector) | Creates an integer coordinate vector from a floating-point coordinate vector |
| new Vector ptr | new | Default constructor: creates a null vector with coordinates (0,0) | |
| new Vector ptr | new | (const Point p) | Default constructor: creates a vector from a point |
| new Vector ptr | new | (int x, int y) | Constructor for a vector from two coordinate values |
| [const] | bool | != | (const Vector v) | Inequality test operator |
| [const] | Vector | * | (double f) | Scaling by some factor |
| [const] | long | * | (const Vector v) | Computes the scalar product between self and the given vector |
| Vector | *= | (double f) | Scaling by some factor | |
| [const] | Vector | + | (const Vector v) | Adds two vectors |
| [const] | Point | + | (const Point p) | Adds a vector and a point |
| [const] | Vector | - | (const Vector v) | Subtract two vectors |
| [const] | Vector | -@ | Compute the negative of a vector | |
| [const] | Vector | / | (double d) | Division by some divisor |
| Vector | /= | (double d) | Division by some divisor | |
| [const] | bool | < | (const Vector v) | "less" comparison operator |
| [const] | bool | == | (const Vector v) | Equality test operator |
| [const] | Vector ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| [const] | double | abs | Returns the length of the vector | |
| void | assign | (const Vector other) | Assigns another object to self | |
| [const] | new Vector ptr | dup | Creates a copy of self | |
| [const] | unsigned long | hash | Computes a hash value | |
| [const] | double | length | Returns the length of the vector | |
| [const] | long | sprod | (const Vector v) | Computes the scalar product between self and the given vector |
| [const] | int | sprod_sign | (const Vector v) | Computes the scalar product between self and the given vector and returns a value indicating the sign of the product |
| [const] | double | sq_abs | The square length of the vector | |
| [const] | double | sq_length | The square length of the vector | |
| [const] | DVector | to_dtype | (double dbu = 1) | Converts the vector to a floating-point coordinate vector |
| [const] | Point | to_p | Turns the vector into a point | |
| [const] | string | to_s | (double dbu = 0) | String conversion |
| [const] | long | vprod | (const Vector v) | Computes the vector product between self and the given vector |
| [const] | int | vprod_sign | (const Vector v) | Computes the vector product between self and the given vector and returns a value indicating the sign of the product |
| [const] | int | x | Accessor to the x coordinate | |
| void | x= | (int coord) | Write accessor to the x coordinate | |
| [const] | int | y | Accessor to the y coordinate | |
| void | y= | (int coord) | Write accessor to the y coordinate |
| new Vector ptr | from_s | (string s) | Creates an object from a string |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
!= | Signature: [const] bool != (const Vector v) Description: Inequality test operator | ||
* | (1) Signature: [const] Vector * (double f) Description: Scaling by some factor Returns the scaled object. All coordinates are multiplied with the given factor and if necessary rounded. Python specific notes: | ||
(2) Signature: [const] long * (const Vector v) Description: Computes the scalar product between self and the given vector The scalar product of a and b is defined as: vp = ax*bx+ay*by. Python specific notes: | |||
*= | Signature: Vector *= (double f) Description: Scaling by some factor Scales object in place. All coordinates are multiplied with the given factor and if necessary rounded. | ||
+ | (1) Signature: [const] Vector + (const Vector v) Description: Adds two vectors Adds vector v to self by adding the coordinates. | ||
(2) Signature: [const] Point + (const Point p) Description: Adds a vector and a point Returns the point p shifted by the vector. | |||
- | Signature: [const] Vector - (const Vector v) Description: Subtract two vectors Subtract vector v from self by subtracting the coordinates. | ||
-@ | Signature: [const] Vector -@ Description: Compute the negative of a vector Returns a new vector with -x,-y. | ||
/ | Signature: [const] Vector / (double d) Description: Division by some divisor Returns the scaled object. All coordinates are divided with the given divisor and if necessary rounded. | ||
/= | Signature: Vector /= (double d) Description: Division by some divisor Divides the object in place. All coordinates are divided with the given divisor and if necessary rounded. | ||
< | Signature: [const] bool < (const Vector v) Description: "less" comparison operator This operator is provided to establish a sorting order | ||
== | Signature: [const] bool == (const Vector v) Description: Equality test operator | ||
_const_cast | Signature: [const] Vector ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | ||
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | ||
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | ||
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. | ||
abs | Signature: [const] double abs Description: Returns the length of the vector 'abs' is an alias provided for compatibility with the former point type. | ||
assign | Signature: void assign (const Vector other) Description: Assigns another object to self | ||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | ||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | ||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | ||
dup | Signature: [const] new Vector ptr dup Description: Creates a copy of self Python specific notes: | ||
from_s | Signature: [static] new Vector ptr from_s (string s) Description: Creates an object from a string Creates the object from a string representation (as returned by to_s) | ||
hash | Signature: [const] unsigned long hash Description: Computes a hash value Returns a hash value for the given vector. This method enables vectors as hash keys. This method has been introduced in version 0.25. Python specific notes: | ||
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||
length | Signature: [const] double length Description: Returns the length of the vector 'abs' is an alias provided for compatibility with the former point type. | ||
new | (1) Signature: [static] new Vector ptr new (const DVector dvector) Description: Creates an integer coordinate vector from a floating-point coordinate vector Python specific notes: | ||
(2) Signature: [static] new Vector ptr new Description: Default constructor: creates a null vector with coordinates (0,0) Python specific notes: | |||
(3) Signature: [static] new Vector ptr new (const Point p) Description: Default constructor: creates a vector from a point This constructor is equivalent to computing p-point(0,0). This method has been introduced in version 0.25. Python specific notes: | |||
(4) Signature: [static] new Vector ptr new (int x, int y) Description: Constructor for a vector from two coordinate values Python specific notes: | |||
sprod | Signature: [const] long sprod (const Vector v) Description: Computes the scalar product between self and the given vector The scalar product of a and b is defined as: vp = ax*bx+ay*by. | ||
sprod_sign | Signature: [const] int sprod_sign (const Vector v) Description: Computes the scalar product between self and the given vector and returns a value indicating the sign of the product
| ||
sq_abs | Signature: [const] double sq_abs Description: The square length of the vector 'sq_abs' is an alias provided for compatibility with the former point type. | ||
sq_length | Signature: [const] double sq_length Description: The square length of the vector 'sq_abs' is an alias provided for compatibility with the former point type. | ||
to_dtype | Signature: [const] DVector to_dtype (double dbu = 1) Description: Converts the vector to a floating-point coordinate vector The database unit can be specified to translate the integer-coordinate vector into a floating-point coordinate vector in micron units. The database unit is basically a scaling factor. | ||
to_p | Signature: [const] Point to_p Description: Turns the vector into a point This method returns the point resulting from adding the vector to (0,0). This method has been introduced in version 0.25. | ||
to_s | Signature: [const] string to_s (double dbu = 0) Description: String conversion If a DBU is given, the output units will be micrometers. The DBU argument has been added in version 0.27.6. Python specific notes: | ||
vprod | Signature: [const] long vprod (const Vector v) Description: Computes the vector product between self and the given vector The vector product of a and b is defined as: vp = ax*by-ay*bx. | ||
vprod_sign | Signature: [const] int vprod_sign (const Vector v) Description: Computes the vector product between self and the given vector and returns a value indicating the sign of the product
| ||
x | Signature: [const] int x Description: Accessor to the x coordinate Python specific notes: | ||
x= | Signature: void x= (int coord) Description: Write accessor to the x coordinate Python specific notes: | ||
y | Signature: [const] int y Description: Accessor to the y coordinate Python specific notes: | ||
y= | Signature: void y= (int coord) Description: Write accessor to the y coordinate Python specific notes: |