Class: Sign
Deprecated
CircuitValue is deprecated in favor of Struct, which features a simpler API and better typing.
Hierarchy
↳
Sign
Table of contents
Constructors
Properties
Accessors
Methods
- assertEquals
- equals
- isConstant
- isPositive
- mul
- neg
- toConstant
- toFields
- toJSON
- toString
- check
- fromFields
- fromJSON
- fromObject
- sizeInFields
- toAuxiliary
- toConstant
- toFields
- toInput
- toJSON
Constructors
constructor
• new Sign(...props)
Parameters
| Name | Type |
|---|---|
...props | any[] |
Inherited from
Defined in
Properties
value
• value: Field
Defined in
Accessors
minusOne
• Static get minusOne(): Sign
Returns
Defined in
one
• Static get one(): Sign
Returns
Defined in
Methods
assertEquals
▸ assertEquals(x): void
Parameters
| Name | Type |
|---|---|
x | Sign |
Returns
void
Inherited from
Defined in
equals
▸ equals(x): Bool
Parameters
| Name | Type |
|---|---|
x | Sign |
Returns
Inherited from
Defined in
isConstant
▸ isConstant(): boolean
Returns
boolean
Inherited from
Defined in
isPositive
▸ isPositive(): Bool
Returns
Defined in
mul
▸ mul(y): Sign
Parameters
| Name | Type |
|---|---|
y | Sign |
Returns
Defined in
neg
▸ neg(): Sign
Returns
Defined in
toConstant
▸ toConstant(): Sign
Returns
Inherited from
Defined in
toFields
▸ toFields(): Field[]
Returns
Field[]
Inherited from
Defined in
toJSON
▸ toJSON(): any
Returns
any
Inherited from
Defined in
toString
▸ toString(): string
Returns
string
Defined in
check
▸ Static check(x): void
Parameters
| Name | Type |
|---|---|
x | Sign |
Returns
void
Overrides
Defined in
fromFields
▸ Static fromFields<T>(this, xs): InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends AnyConstructor |
Parameters
| Name | Type |
|---|---|
this | T |
xs | Field[] |
Returns
InstanceType<T>
Inherited from
Defined in
fromJSON
▸ Static fromJSON<T>(x): InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends AnyConstructor |
Parameters
| Name | Type |
|---|---|
x | "Positive" | "Negative" |
Returns
InstanceType<T>
Overrides
Defined in
fromObject
▸ Static fromObject<T>(this, value): InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends AnyConstructor |
Parameters
| Name | Type |
|---|---|
this | T |
value | NonMethods<InstanceType<T>> |
Returns
InstanceType<T>
Inherited from
Defined in
sizeInFields
▸ Static sizeInFields(): number
Returns
number
Inherited from
Defined in
toAuxiliary
▸ Static toAuxiliary(): []
Returns
[]
Inherited from
Defined in
toConstant
▸ Static toConstant<T>(this, t): InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends AnyConstructor |
Parameters
| Name | Type |
|---|---|
this | T |
t | InstanceType<T> |
Returns
InstanceType<T>
Inherited from
Defined in
toFields
▸ Static toFields<T>(this, v): Field[]
Type parameters
| Name | Type |
|---|---|
T | extends AnyConstructor |
Parameters
| Name | Type |
|---|---|
this | T |
v | InstanceType<T> |
Returns
Field[]
Inherited from
Defined in
toInput
▸ Static toInput(x): HashInput
Parameters
| Name | Type |
|---|---|
x | Sign |
Returns
HashInput
Overrides
Defined in
toJSON
▸ Static toJSON(x): "Positive" | "Negative"
Parameters
| Name | Type |
|---|---|
x | Sign |
Returns
"Positive" | "Negative"