keys¶

Bindings for utility::keys namespace

class pyrosetta.rosetta.utility.keys.Key¶

Bases: pybind11_builtins.pybind11_object

Hidden index key interface class

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__¶: Initialize self. See help(type(self)) for accurate signature.

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.utility.keys.Key, key: pyrosetta.rosetta.utility.keys.Key) → pyrosetta.rosetta.utility.keys.Key¶

Copy assignment

C++: utility::keys::Key::operator=(const class utility::keys::Key &) –> class utility::keys::Key &

clone(self: pyrosetta.rosetta.utility.keys.Key) → pyrosetta.rosetta.utility.keys.Key¶

Clone this

C++: utility::keys::Key::clone() const –> class utility::keys::Key *

code(*args, **kwargs)¶

Overloaded function.

code(self: pyrosetta.rosetta.utility.keys.Key) -> str

Code

C++: utility::keys::Key::code() –> std::string &

code(self: pyrosetta.rosetta.utility.keys.Key, code_a: str) -> pyrosetta.rosetta.utility.keys.Key

Code assignment

C++: utility::keys::Key::code(const class std::basic_string<char> &) –> class utility::keys::Key &

id(*args, **kwargs)¶

Overloaded function.

id(self: pyrosetta.rosetta.utility.keys.Key) -> str

ID

C++: utility::keys::Key::id() –> std::string &

id(self: pyrosetta.rosetta.utility.keys.Key, id_a: str) -> pyrosetta.rosetta.utility.keys.Key

ID assignment

C++: utility::keys::Key::id(const class std::basic_string<char> &) –> class utility::keys::Key &

identifier(*args, **kwargs)¶

Overloaded function.

identifier(self: pyrosetta.rosetta.utility.keys.Key) -> str

Identifier

C++: utility::keys::Key::identifier() –> std::string &

identifier(self: pyrosetta.rosetta.utility.keys.Key, identifier_a: str) -> pyrosetta.rosetta.utility.keys.Key

Identifier assignment

C++: utility::keys::Key::identifier(const class std::basic_string<char> &) –> class utility::keys::Key &

private_index(self: pyrosetta.rosetta.utility.keys.Key) → int¶

Index

Only for use as an optimization: DO NOT WRITE CODE DEPENDING ON THE SPECIFIC INDEX VALUE!

C++: utility::keys::Key::private_index() const –> unsigned long

class pyrosetta.rosetta.utility.keys.NoClient¶

Bases: pybind11_builtins.pybind11_object

Default key policy class when no client is needed to distinguish key type

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.utility.keys.NoClient) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

pyrosetta.rosetta.utility.keys.comparable(a: pyrosetta.rosetta.utility.keys.Key, b: pyrosetta.rosetta.utility.keys.Key) → bool¶

Are Keys of Comparable Types?

C++: utility::keys::comparable(const class utility::keys::Key &, const class utility::keys::Key &) –> bool