QPanda3
Supported by OriginQ
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pyqpanda3.qcloud.qcloud.QCloudOptions Class Reference

A class for representing and managing quantum cloud job options. More...

Public Member Functions

None __init__ (self)
 init(self: qcloud.QCloudOptions) -> None
 
int get_custom_option (self, str arg0)
 get_custom_option(*args, **kwargs) Overloaded function.
 
float get_custom_option (self, str arg0)
 get_custom_option(*args, **kwargs) Overloaded function.
 
str get_custom_option (self, str arg0)
 get_custom_option(*args, **kwargs) Overloaded function.
 
bool get_custom_option (self, str arg0)
 get_custom_option(*args, **kwargs) Overloaded function.
 
dict[str, int|float|str|bool] get_custom_options (self)
 get_custom_options(self: qcloud.QCloudOptions) -> dict[str, Union[int, float, str, bool]]
 
bool has_custom_option (self, str arg0)
 has_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool
 
bool is_amend (self)
 is_amend(self: qcloud.QCloudOptions) -> bool
 
bool is_mapping (self)
 is_mapping(self: qcloud.QCloudOptions) -> bool
 
bool is_optimization (self)
 is_optimization(self: qcloud.QCloudOptions) -> bool
 
bool is_prob_counts (self)
 is_prob_counts(self: qcloud.QCloudOptions) -> bool
 
int point_label (self)
 point_label(self: qcloud.QCloudOptions) -> int
 
None print (self)
 print(self: qcloud.QCloudOptions) -> None
 
None set_amend (self, bool arg0)
 set_amend(self: qcloud.QCloudOptions, arg0: bool) -> None
 
None set_custom_option (self, str arg0, int|float|str|bool arg1)
 set_custom_option(self: qcloud.QCloudOptions, arg0: str, arg1: Union[int, float, str, bool]) -> None
 
None set_is_prob_counts (self, bool arg0)
 set_is_prob_counts(self: qcloud.QCloudOptions, arg0: bool) -> None
 
None set_mapping (self, bool arg0)
 set_mapping(self: qcloud.QCloudOptions, arg0: bool) -> None
 
None set_optimization (self, bool arg0)
 set_optimization(self: qcloud.QCloudOptions, arg0: bool) -> None
 
None set_point_label (self, int arg0)
 set_point_label(self: qcloud.QCloudOptions, arg0: int) -> None
 
None set_specified_block (self, list[int] arg0)
 set_specified_block(self: qcloud.QCloudOptions, arg0: list[int]) -> None
 
list[int] specified_block (self)
 specified_block(self: qcloud.QCloudOptions) -> list[int]
 

Detailed Description

A class for representing and managing quantum cloud job options.

This class allows you to configure various options such as amendment, mapping, optimization, and custom options.

Constructor & Destructor Documentation

◆ __init__()

None pyqpanda3.qcloud.qcloud.QCloudOptions.__init__ ( self)

init(self: qcloud.QCloudOptions) -> None

Default constructor for QCloudOptions.

Initializes all options to their default values.

Member Function Documentation

◆ get_custom_option() [1/4]

int pyqpanda3.qcloud.qcloud.QCloudOptions.get_custom_option ( self,
str arg0 )

get_custom_option(*args, **kwargs) Overloaded function.

  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> int
@brief Retrieves a custom option by key as an integer value.
@param[in] key The key of the custom option.
@return The value of the custom option as an integer.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> float
@brief Retrieves a custom option by key as a double value.
@param[in] key The key of the custom option.
@return The value of the custom option as a double.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> str
@brief Retrieves a custom option by key as a string value.
@param[in] key The key of the custom option.
@return The value of the custom option as a string.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool
@brief Retrieves a custom option by key as a boolean value.
@param[in] key The key of the custom option.
@return The value of the custom option as a boolean.

◆ get_custom_option() [2/4]

float pyqpanda3.qcloud.qcloud.QCloudOptions.get_custom_option ( self,
str arg0 )

get_custom_option(*args, **kwargs) Overloaded function.

  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> int
@brief Retrieves a custom option by key as an integer value.
@param[in] key The key of the custom option.
@return The value of the custom option as an integer.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> float
@brief Retrieves a custom option by key as a double value.
@param[in] key The key of the custom option.
@return The value of the custom option as a double.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> str
@brief Retrieves a custom option by key as a string value.
@param[in] key The key of the custom option.
@return The value of the custom option as a string.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool
@brief Retrieves a custom option by key as a boolean value.
@param[in] key The key of the custom option.
@return The value of the custom option as a boolean.

◆ get_custom_option() [3/4]

str pyqpanda3.qcloud.qcloud.QCloudOptions.get_custom_option ( self,
str arg0 )

get_custom_option(*args, **kwargs) Overloaded function.

  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> int
@brief Retrieves a custom option by key as an integer value.
@param[in] key The key of the custom option.
@return The value of the custom option as an integer.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> float
@brief Retrieves a custom option by key as a double value.
@param[in] key The key of the custom option.
@return The value of the custom option as a double.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> str
@brief Retrieves a custom option by key as a string value.
@param[in] key The key of the custom option.
@return The value of the custom option as a string.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool
@brief Retrieves a custom option by key as a boolean value.
@param[in] key The key of the custom option.
@return The value of the custom option as a boolean.

◆ get_custom_option() [4/4]

bool pyqpanda3.qcloud.qcloud.QCloudOptions.get_custom_option ( self,
str arg0 )

get_custom_option(*args, **kwargs) Overloaded function.

  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> int
@brief Retrieves a custom option by key as an integer value.
@param[in] key The key of the custom option.
@return The value of the custom option as an integer.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> float
@brief Retrieves a custom option by key as a double value.
@param[in] key The key of the custom option.
@return The value of the custom option as a double.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> str
@brief Retrieves a custom option by key as a string value.
@param[in] key The key of the custom option.
@return The value of the custom option as a string.
  1. get_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool
@brief Retrieves a custom option by key as a boolean value.
@param[in] key The key of the custom option.
@return The value of the custom option as a boolean.

◆ get_custom_options()

dict[str, int | float | str | bool] pyqpanda3.qcloud.qcloud.QCloudOptions.get_custom_options ( self)

get_custom_options(self: qcloud.QCloudOptions) -> dict[str, Union[int, float, str, bool]]

Retrieves all custom options.

Returns
A dictionary of all custom options, where keys are option names and values are the option values.

◆ has_custom_option()

bool pyqpanda3.qcloud.qcloud.QCloudOptions.has_custom_option ( self,
str arg0 )

has_custom_option(self: qcloud.QCloudOptions, arg0: str) -> bool

Checks if a custom option with the given key exists.

Parameters
[in]keyThe key of the custom option.
Returns
True if the custom option exists, false otherwise.

◆ is_amend()

bool pyqpanda3.qcloud.qcloud.QCloudOptions.is_amend ( self)

is_amend(self: qcloud.QCloudOptions) -> bool

Checks whether amendment is enabled.

Returns
A boolean indicating whether amendment is enabled.

◆ is_mapping()

bool pyqpanda3.qcloud.qcloud.QCloudOptions.is_mapping ( self)

is_mapping(self: qcloud.QCloudOptions) -> bool

Checks whether mapping is enabled.

Returns
A boolean indicating whether mapping is enabled.

◆ is_optimization()

bool pyqpanda3.qcloud.qcloud.QCloudOptions.is_optimization ( self)

is_optimization(self: qcloud.QCloudOptions) -> bool

Checks whether optimization is enabled.

Returns
A boolean indicating whether optimization is enabled.

◆ is_prob_counts()

bool pyqpanda3.qcloud.qcloud.QCloudOptions.is_prob_counts ( self)

is_prob_counts(self: qcloud.QCloudOptions) -> bool

Checks is_prob_counts value.

Returns
is_prob_counts value.

◆ point_label()

int pyqpanda3.qcloud.qcloud.QCloudOptions.point_label ( self)

point_label(self: qcloud.QCloudOptions) -> int

Checks point label value.

Returns
A int number represent point label value.

◆ print()

None pyqpanda3.qcloud.qcloud.QCloudOptions.print ( self)

print(self: qcloud.QCloudOptions) -> None

Prints the current settings of the options.

◆ set_amend()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_amend ( self,
bool arg0 )

set_amend(self: qcloud.QCloudOptions, arg0: bool) -> None

Set whether amendment is enabled.

Parameters
[in]is_amendA boolean indicating whether amendment is enabled.

◆ set_custom_option()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_custom_option ( self,
str arg0,
int | float | str | bool arg1 )

set_custom_option(self: qcloud.QCloudOptions, arg0: str, arg1: Union[int, float, str, bool]) -> None

Sets a custom option with a given key and value.

Parameters
[in]keyThe key for the custom option.
[in]valueThe value for the custom option, which can be int, double, string, or bool.

◆ set_is_prob_counts()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_is_prob_counts ( self,
bool arg0 )

set_is_prob_counts(self: qcloud.QCloudOptions, arg0: bool) -> None

set_is_prob_counts for real chip task.

Parameters
[in]is_prob_counts.

◆ set_mapping()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_mapping ( self,
bool arg0 )

set_mapping(self: qcloud.QCloudOptions, arg0: bool) -> None

Set whether mapping is enabled.

Parameters
[in]is_mappingA boolean indicating whether mapping is enabled.

◆ set_optimization()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_optimization ( self,
bool arg0 )

set_optimization(self: qcloud.QCloudOptions, arg0: bool) -> None

Set whether optimization is enabled.

Parameters
[in]is_optimizationA boolean indicating whether optimization is enabled.

◆ set_point_label()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_point_label ( self,
int arg0 )

set_point_label(self: qcloud.QCloudOptions, arg0: int) -> None

Set point label for real chip task.

Parameters
[in]pointlabel a int level number.

◆ set_specified_block()

None pyqpanda3.qcloud.qcloud.QCloudOptions.set_specified_block ( self,
list[int] arg0 )

set_specified_block(self: qcloud.QCloudOptions, arg0: list[int]) -> None

set_specified_block for real chip task.

Parameters
[in]specified_block.

◆ specified_block()

list[int] pyqpanda3.qcloud.qcloud.QCloudOptions.specified_block ( self)

specified_block(self: qcloud.QCloudOptions) -> list[int]

Checks specified_block value.

Returns
specified_block value.
The documentation for this class was generated from the following file: