API reference - Class EqualDeviceParameters

Notation used in Ruby API documentation

Module: db

Description: A device parameter equality comparer.

Attach this object to a device class with DeviceClass#equal_parameters= to make the device class use this comparer:

# 20nm tolerance for length:
equal_device_parameters = RBA::EqualDeviceParameters::new(RBA::DeviceClassMOS4Transistor::PARAM_L, 0.02, 0.0)
# one percent tolerance for width:
equal_device_parameters += RBA::EqualDeviceParameters::new(RBA::DeviceClassMOS4Transistor::PARAM_W, 0.0, 0.01)
# applies the compare delegate:
netlist.device_class_by_name("NMOS").equal_parameters = equal_device_parameters

You can use this class to specify fuzzy equality criteria for the comparison of device parameters in netlist verification or to confine the equality of devices to certain parameters only.

This class has been added in version 0.26.

Public constructors

new EqualDeviceParameters ptrnew(unsigned long param_id,
double absolute = 0,
double relative = 0)
Creates a device parameter comparer for a single parameter.

Public methods

[const]EqualDeviceParameters+(const EqualDeviceParameters other)Combines two parameters for comparison.
[const]EqualDeviceParameters+=(const EqualDeviceParameters other)Combines two parameters for comparison (in-place).
void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const EqualDeviceParameters other)Assigns another object to self
[const]new EqualDeviceParameters ptrdupCreates a copy of self

Public static methods and constants

new EqualDeviceParameters ptrignore(unsigned long param_id)Creates a device parameter comparer which ignores the parameter.

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

+

Signature: [const] EqualDeviceParameters + (const EqualDeviceParameters other)

Description: Combines two parameters for comparison.

The '+' operator will join the parameter comparers and produce one that checks the combined parameters.

+=

Signature: [const] EqualDeviceParameters += (const EqualDeviceParameters other)

Description: Combines two parameters for comparison (in-place).

The '+=' operator will join the parameter comparers and produce one that checks the combined parameters.

_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.

assign

Signature: void assign (const EqualDeviceParameters 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 EqualDeviceParameters ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__'

ignore

Signature: [static] new EqualDeviceParameters ptr ignore (unsigned long param_id)

Description: Creates a device parameter comparer which ignores the parameter.

This specification can be used to make a parameter ignored. Starting with version 0.27.4, all primary parameters are compared. Before 0.27.4, giving a tolerance meant only those parameters are compared. To exclude a primary parameter from the compare, use the 'ignore' specification for that parameter.

This constructor has been introduced in version 0.27.4.

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.

new

Signature: [static] new EqualDeviceParameters ptr new (unsigned long param_id, double absolute = 0, double relative = 0)

Description: Creates a device parameter comparer for a single parameter.

'absolute' is the absolute deviation allowed for the parameter values. 'relative' is the relative deviation allowed for the parameter values (a value between 0 and 1).

A value of 0 for both absolute and relative deviation means the parameters have to match exactly.

If 'absolute' and 'relative' are both given, their deviations will add to the allowed difference between two parameter values. The relative deviation will be applied to the mean value of both parameter values. For example, when comparing parameter values of 40 and 60, a relative deviation of 0.35 means an absolute deviation of 17.5 (= 0.35 * average of 40 and 60) which does not make both values match.

Python specific notes:
This method is the default initializer of the object