keys

Bindings for utility::keys namespace

class pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

Bases: Key

assign(*args, **kwargs)

Overloaded function.

1. assign(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, key: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::operator=(const class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

2. assign(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, key: pyrosetta.rosetta.utility.keys.Key) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::operator=(const class utility::keys::Key &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

3. assign(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t, 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(*args, **kwargs)

Overloaded function.

1. clone(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::clone() const –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> *

2. clone(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> pyrosetta.rosetta.utility.keys.Key

Clone this

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

code(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code() –> std::string &

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::code(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

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

Code

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

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

Code assignment

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

id(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id() –> std::string &

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::id(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

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

ID

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

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

ID assignment

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

identifier(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier() –> std::string &

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

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::identifier(const std::string &) –> class utility::keys::AutoKey<class utility::options::Option, class utility::keys::Key, class utility::keys::NoClient> &

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

Identifier

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

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

Identifier assignment

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

static n_key() → int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::n_key() –> unsigned long

private_index(*args, **kwargs)

Overloaded function.

1. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> int

C++: utility::keys::AutoKey<utility::options::Option, utility::keys::Key, utility::keys::NoClient>::private_index() const –> unsigned long

2. private_index(self: pyrosetta.rosetta.utility.keys.AutoKey_utility_options_Option_utility_keys_Key_utility_keys_NoClient_t) -> 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.Key

Bases: pybind11_object

Hidden index key interface class

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.

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

Code

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

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

Code assignment

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

id(*args, **kwargs)

Overloaded function.

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

ID

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

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

ID assignment

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

identifier(*args, **kwargs)

Overloaded function.

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

Identifier

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

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

Identifier assignment

C++: utility::keys::Key::identifier(const std::string &) –> 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.Key2Tuple_double_double_t

Bases: pybind11_object

key1(self: pyrosetta.rosetta.utility.keys.Key2Tuple_double_double_t) → float

C++: utility::keys::Key2Tuple<double, double>::key1() –> double &

key2(self: pyrosetta.rosetta.utility.keys.Key2Tuple_double_double_t) → float

C++: utility::keys::Key2Tuple<double, double>::key2() –> double &

class pyrosetta.rosetta.utility.keys.Key2Tuple_unsigned_long_unsigned_long_t

Bases: pybind11_object

key1(self: pyrosetta.rosetta.utility.keys.Key2Tuple_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key2Tuple<unsigned long, unsigned long>::key1() –> unsigned long &

key2(self: pyrosetta.rosetta.utility.keys.Key2Tuple_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key2Tuple<unsigned long, unsigned long>::key2() –> unsigned long &

class pyrosetta.rosetta.utility.keys.Key3Tuple_unsigned_long_unsigned_long_unsigned_long_t

Bases: pybind11_object

key1(self: pyrosetta.rosetta.utility.keys.Key3Tuple_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key3Tuple<unsigned long, unsigned long, unsigned long>::key1() –> unsigned long &

key2(self: pyrosetta.rosetta.utility.keys.Key3Tuple_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key3Tuple<unsigned long, unsigned long, unsigned long>::key2() –> unsigned long &

key3(self: pyrosetta.rosetta.utility.keys.Key3Tuple_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key3Tuple<unsigned long, unsigned long, unsigned long>::key3() –> unsigned long &

class pyrosetta.rosetta.utility.keys.Key4Tuple_unsigned_long_unsigned_long_unsigned_long_unsigned_long_t

Bases: pybind11_object

key1(self: pyrosetta.rosetta.utility.keys.Key4Tuple_unsigned_long_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key4Tuple<unsigned long, unsigned long, unsigned long, unsigned long>::key1() –> unsigned long &

key2(self: pyrosetta.rosetta.utility.keys.Key4Tuple_unsigned_long_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key4Tuple<unsigned long, unsigned long, unsigned long, unsigned long>::key2() –> unsigned long &

key3(self: pyrosetta.rosetta.utility.keys.Key4Tuple_unsigned_long_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key4Tuple<unsigned long, unsigned long, unsigned long, unsigned long>::key3() –> unsigned long &

key4(self: pyrosetta.rosetta.utility.keys.Key4Tuple_unsigned_long_unsigned_long_unsigned_long_unsigned_long_t) → int

C++: utility::keys::Key4Tuple<unsigned long, unsigned long, unsigned long, unsigned long>::key4() –> unsigned long &

class pyrosetta.rosetta.utility.keys.NoClient

Bases: pybind11_object

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

class pyrosetta.rosetta.utility.keys.VariantKey_utility_options_OptionKey_t

Bases: pybind11_object

assign(self: pyrosetta.rosetta.utility.keys.VariantKey_utility_options_OptionKey_t, var: pyrosetta.rosetta.utility.keys.VariantKey_utility_options_OptionKey_t) → pyrosetta.rosetta.utility.keys.VariantKey_utility_options_OptionKey_t

C++: utility::keys::VariantKey<utility::options::OptionKey>::operator=(const class utility::keys::VariantKey<class utility::options::OptionKey> &) –> class utility::keys::VariantKey<class utility::options::OptionKey> &

code(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::code() –> std::string &

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::code(const std::string &) –> class utility::keys::VariantKey<class utility::options::OptionKey> &

id(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::id() –> std::string &

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::id(const std::string &) –> class utility::keys::VariantKey<class utility::options::OptionKey> &

identifier(*args, **kwargs)

Overloaded function.

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::identifier() –> std::string &

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::identifier(const std::string &) –> class utility::keys::VariantKey<class utility::options::OptionKey> &

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

C++: utility::keys::VariantKey<utility::options::OptionKey>::private_index() const –> unsigned long

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