Struct Real

Structure defining a real number.

Implements

IEquatable<Real>

IDotProduct<Real, Double>

INorm<Real>

IMetric<Real>

IGroupAction<Real, Double>

Namespace: BRIDGES.Arithmetic.Numbers

Assembly: BRIDGES.dll

Syntax

public struct Real : IDotProduct<Real, double>, INorm<Real>, IMetric<Real>, IGroupAction<Real, double>

Constructors

| Improve this Doc View Source

Real(Real)

Initialises a new instance of the Real structure from another Real number.

Declaration

public Real(Real real)

Parameters

Type	Name	Description
Real	real	Real number to deep copy.

| Improve this Doc View Source

Real(Double)

Initialises a new instance of the Real structure by defining its value.

Declaration

public Real(double number)

Parameters

Type	Name	Description
Double	number	Value of the real number.

Properties

| Improve this Doc View Source

One

Gets a new instance of the Real structure equal to one : 1.0..

Declaration

public static readonly Real One { get; }

Property Value

Type	Description
Real	The new Real number equal to one.

| Improve this Doc View Source

Value

Value of the real numbers.

Declaration

public double Value { get; set; }

Property Value

Type	Description
Double

| Improve this Doc View Source

Zero

Gets a new instance of the Real structure equal to zero : 0.0.

Declaration

public static readonly Real Zero { get; }

Property Value

Type	Description
Real

Methods

| Improve this Doc View Source

Add(Real, Real)

Computes the addition of two Real numbers.

Declaration

public static Real Add(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number for the addition.
Real	right	Right Real number for the addition.

Returns

Type	Description
Real	The new Real number resulting from the addition.

| Improve this Doc View Source

DistanceTo(Real)

Computes the distance of this element to another element.

Declaration

public double DistanceTo(Real other)

Parameters

Type	Name	Description
Real	other

Returns

Type	Description
Double	The value of the distance between the two elements.

| Improve this Doc View Source

Divide(Real, Real)

Computes the division of two Real numbers.

Declaration

public static Real Divide(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Real number to divide.
Real	right	Real number to divide with.

Returns

Type	Description
Real	The new Real number resulting from the division.

| Improve this Doc View Source

Divide(Real, Double)

Computes the scalar division of a Real number with a -precision real number.

Declaration

public static Real Divide(Real operand, double divisor)

Parameters

Type	Name	Description
Real	operand	Real number to divide.
Double	divisor	-precision real number to divide with.

Returns

Type	Description
Real	The new Real number resulting from the scalar division.

| Improve this Doc View Source

DotProduct(Real)

Computes the dot product of this element with another element.

Declaration

public double DotProduct(Real other)

Parameters

Type	Name	Description
Real	other

Returns

Type	Description
Double	The value of the dot product of the two elements.

| Improve this Doc View Source

Equals(Real)

Structure defining a real number.

Declaration

public bool Equals(Real other)

Parameters

Type	Name	Description
Real	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Structure defining a real number.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

| Improve this Doc View Source

GetHashCode()

Structure defining a real number.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

| Improve this Doc View Source

Inverse(Real)

Computes the inverse of the Real number.

Declaration

public static Real Inverse(Real operand)

Parameters

Type	Name	Description
Real	operand	Real number from which the inverse is computed.

Returns

Type	Description
Real	The new Real number, inverse of the initial one.

| Improve this Doc View Source

Multiply(Real, Real)

Computes the multiplication of two Real numbers.

Declaration

public static Real Multiply(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number for the multiplication.
Real	right	Right Real number for the multiplication.

Returns

Type	Description
Real	The new Real number resulting from the multiplication.

| Improve this Doc View Source

Multiply(Real, Double)

Computes the left scalar multiplication of a Real number with a -precision real number.

Declaration

public static Real Multiply(Real operand, double factor)

Parameters

Type	Name	Description
Real	operand	Real number to multiply.
Double	factor	-precision real number.

Returns

Type	Description
Real	The new Real number resulting from the scalar multiplication.

| Improve this Doc View Source

Multiply(Double, Real)

Computes the right scalar multiplication of a Real number with a -precision real number.

Declaration

public static Real Multiply(double factor, Real operand)

Parameters

Type	Name	Description
Double	factor	-precision real number.
Real	operand	Real number to multiply.

Returns

Type	Description
Real	The new Real number resulting from the scalar multiplication.

| Improve this Doc View Source

Norm()

Computes the norm of this element.

Declaration

public double Norm()

Returns

Type	Description
Double	The value of the norm.

| Improve this Doc View Source

Opposite(Real)

Computes the opposite of the Real number.

Declaration

public static Real Opposite(Real operand)

Parameters

Type	Name	Description
Real	operand	Real number from which the opposite is computed.

Returns

Type	Description
Real	The new Real number, opposite of the initial one.

| Improve this Doc View Source

Subtract(Real, Real)

Computes the subtraction of two Real numbers.

Declaration

public static Real Subtract(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number to subtract.
Real	right	Right Real number to subtract with.

Returns

Type	Description
Real	The new Real number resulting from the subtraction.

| Improve this Doc View Source

ToString()

Structure defining a real number.

Declaration

public override string ToString()

Returns

Type	Description
String

Operators

| Improve this Doc View Source

Addition(Real, Real)

Computes the addition of two Real numbers.

Declaration

public static Real operator +(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number for the addition.
Real	right	Right Real number for the addition.

Returns

Type	Description
Real	The new Real number resulting from the addition.

| Improve this Doc View Source

Addition(Real, Double)

Computes the right addition of a Real number with a number.

Declaration

public static Real operator +(Real left, double right)

Parameters

Type	Name	Description
Real	left	Real number for the addition.
Double	right	number for the addition.

Returns

Type	Description
Real	The new Real number resulting from the addition.

| Improve this Doc View Source

Addition(Double, Real)

Computes the left addition of a Real number with a number.

Declaration

public static Real operator +(double left, Real right)

Parameters

Type	Name	Description
Double	left	number for the addition.
Real	right	Real number for the addition.

Returns

Type	Description
Real	The new Real number resulting from the addition.

| Improve this Doc View Source

Division(Real, Real)

Computes the division of two Real numbers.

Declaration

public static Real operator /(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Real number to divide.
Real	right	Real number to divide with.

Returns

Type	Description
Real	The new Real number resulting from the division.

| Improve this Doc View Source

Division(Real, Double)

Computes the division of a Real number with a number.

Declaration

public static Real operator /(Real left, double right)

Parameters

Type	Name	Description
Real	left	Real number to divide.
Double	right	number to divide with.

Returns

Type	Description
Real	The new Real number resulting from the division.

| Improve this Doc View Source

Division(Double, Real)

Computes the division of a number with a Real number.

Declaration

public static Real operator /(double left, Real right)

Parameters

Type	Name	Description
Double	left	number to divide.
Real	right	Real number to divide with.

Returns

Type	Description
Real	The new Real number resulting from the division.

| Improve this Doc View Source

Explicit(Real to Double)

Converts a Real number into a -precision real number.

Declaration

public static explicit operator double (Real real)

Parameters

Type	Name	Description
Real	real	Real number to convert.

Returns

Type	Description
Double	The new -precision real number resulting from the conversion.

| Improve this Doc View Source

Explicit(Double to Real)

Converts a -precision real number into a Real number.

Declaration

public static explicit operator Real(double number)

Parameters

Type	Name	Description
Double	number	-precision real number to convert.

Returns

Type	Description
Real	The new Real number resulting from the conversion.

| Improve this Doc View Source

Multiply(Real, Real)

Computes the multiplication of two Real numbers.

Declaration

public static Real operator *(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number for the multiplication.
Real	right	Right Real number for the multiplication.

Returns

Type	Description
Real	The new Real number resulting from the multiplication.

| Improve this Doc View Source

Multiply(Real, Double)

Computes the right multiplication of a Real number with a number.

Declaration

public static Real operator *(Real left, double right)

Parameters

Type	Name	Description
Real	left	Real number for the multiplicaion.
Double	right	number for the multiplicaion.

Returns

Type	Description
Real	The new Real number resulting from the multiplication.

| Improve this Doc View Source

Multiply(Double, Real)

Computes the left multiplication of a Real number with a number.

Declaration

public static Real operator *(double left, Real right)

Parameters

Type	Name	Description
Double	left	number for the multiplicaion.
Real	right	Real number for the multiplicaion.

Returns

Type	Description
Real	The new Real number resulting from the multiplication.

| Improve this Doc View Source

Subtraction(Real, Real)

Computes the subtraction of two Real numbers.

Declaration

public static Real operator -(Real left, Real right)

Parameters

Type	Name	Description
Real	left	Left Real number to subtract.
Real	right	Right Real number to subtract with.

Returns

Type	Description
Real	The new Real number resulting from the subtraction.

| Improve this Doc View Source

Subtraction(Real, Double)

Computes the subtraction of a Real number with a number.

Declaration

public static Real operator -(Real left, double right)

Parameters

Type	Name	Description
Real	left	Real number to subtract.
Double	right	number to subtract with.

Returns

Type	Description
Real	The new Real number resulting from the subtraction.

| Improve this Doc View Source

Subtraction(Double, Real)

Computes the subtraction of a number with a Real number.

Declaration

public static Real operator -(double left, Real right)

Parameters

Type	Name	Description
Double	left	number to subtract.
Real	right	Real number to subtract with.

Returns

Type	Description
Real	The new Real number resulting from the subtraction.

| Improve this Doc View Source

UnaryNegation(Real)

Computes the opposite of the Real number.

Declaration

public static Real operator -(Real operand)

Parameters

Type	Name	Description
Real	operand	Real number from which the opposite is computed.

Returns

Type	Description
Real	The new Real number, opposite of the initial one.

Explicit Interface Implementations

| Improve this Doc View Source

IGroupAction<Real, Double>.Divide(Double)

Computes the right scalar division of the current element.

Declaration

Real IGroupAction<Real, double>.Divide(double divisor)

Parameters

Type	Name	Description
Double	divisor

Returns

Type	Description
Real	The new element resulting from the scalar dividion.

| Improve this Doc View Source

IGroupAction<Real, Double>.Multiply(Double)

Computes the right scalar multiplication of the current element.

Declaration

Real IGroupAction<Real, double>.Multiply(double factor)

Parameters

Type	Name	Description
Double	factor

Returns

Type	Description
Real	The new element resulting from the scalar multiplication.

Implements

IEquatable<>

IDotProduct<TSelf, TValue>

INorm<TSelf>

IMetric<TSelf>

IGroupAction<TSelf, TValue>