[#mp_units-quantity_point-08]
= xref:mp_units.adoc[mp_units]::quantity_point
:relfileprefix: ../
:mrdocs:

A quantity point

== Synopsis

Declared in `<mp‐units/framework/quantity_point.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/Reference.adoc[Reference] auto R,
    xref:mp_units/PointOriginFor.adoc[PointOriginFor<get_quantity_spec(R)>] auto PO,
    xref:mp_units/RepresentationOf.adoc[RepresentationOf<get_quantity_spec(R)>] Rep>
class quantity_point;
----

== Types

[cols=1]
|===
| Name
| xref:mp_units/quantity_point-08/quantity_type.adoc[`quantity_type`] 
| xref:mp_units/quantity_point-08/rep.adoc[`rep`] 
|===

== Member Functions

[cols=2]
|===
| Name
| Description
| xref:mp_units/quantity_point-08/2constructor-075.adoc[`quantity_point`]         [.small]#[constructor]#
| Constructors
| xref:mp_units/quantity_point-08/2destructor.adoc[`~quantity_point`] [.small]#[destructor]#
| Destructor
| xref:mp_units/quantity_point-08/operator_assign-04.adoc[`operator=`] 
| Assignment operators
| xref:mp_units/quantity_point-08/force_in-03.adoc[`force_in`] 
| 
| xref:mp_units/quantity_point-08/in-0ac.adoc[`in`] 
| 
| xref:mp_units/quantity_point-08/operator_inc-0d.adoc[`operator++`] 
| Increment operators
| xref:mp_units/quantity_point-08/operator_plus_eq.adoc[`operator+=`] 
| Addition assignment operator
| xref:mp_units/quantity_point-08/operator_dec-0f.adoc[`operator‐‐`] 
| Decrement operators
| xref:mp_units/quantity_point-08/operator_minus_eq.adoc[`operator‐=`] 
| Subtraction assignment operator
| xref:mp_units/quantity_point-08/point_for.adoc[`point_for`] 
| 
| xref:mp_units/quantity_point-08/quantity_from-00.adoc[`quantity_from`] 
| 
| xref:mp_units/quantity_point-08/quantity_from_zero.adoc[`quantity_from_zero`] 
| 
| xref:mp_units/quantity_point-08/quantity_ref_from-05.adoc[`quantity_ref_from`] 
| 
| xref:mp_units/quantity_point-08/2conversion-04.adoc[`operator `] 
| Conversion operators
|===

== Static Member Functions

[cols=1]
|===
| Name
| xref:mp_units/quantity_point-08/max.adoc[`max`] 
| xref:mp_units/quantity_point-08/min.adoc[`min`] 
|===

== Data Members

[cols=1]
|===
| Name
| xref:mp_units/quantity_point-08/quantity_from_origin_is_an_implementation_detail_.adoc[`quantity_from_origin_is_an_implementation_detail_`] 
|===

== Static Data Members

[cols=1]
|===
| Name
| xref:mp_units/quantity_point-08/absolute_point_origin.adoc[`absolute_point_origin`] 
| xref:mp_units/quantity_point-08/dimension.adoc[`dimension`] 
| xref:mp_units/quantity_point-08/point_origin.adoc[`point_origin`] 
| xref:mp_units/quantity_point-08/quantity_spec.adoc[`quantity_spec`] 
| xref:mp_units/quantity_point-08/reference.adoc[`reference`] 
| xref:mp_units/quantity_point-08/unit.adoc[`unit`] 
|===

== Friends

[cols=2]
|===
| Name
| Description
| `xref:mp_units/operator_3way-0c8.adoc[mp_units::operator<=>]`
| Three‐way comparison operator
| `xref:mp_units/operator_eq-0ca.adoc[mp_units::operator==]`
| Equality operator
| `xref:mp_units/operator_minus-0e.adoc[mp_units::operator‐]`
| 
| `xref:mp_units/operator_minus-01.adoc[mp_units::operator‐]`
| 
| `xref:mp_units/operator_minus-06.adoc[mp_units::operator‐]`
| 
| `xref:mp_units/operator_minus-05.adoc[mp_units::operator‐]`
| 
| `xref:mp_units/operator_plus-00.adoc[mp_units::operator+]`
| 
| `xref:mp_units/operator_plus-0a5.adoc[mp_units::operator+]`
| 
|===

== Non-Member Functions

[cols=2]
|===
| Name
| Description
| xref:mp_units/isfinite-0b.adoc[`isfinite`]
| Determines if a quantity point is finite.
| xref:mp_units/isinf-04.adoc[`isinf`]
| Determines if a quantity point is infinite.
| xref:mp_units/isnan-082.adoc[`isnan`]
| Determines if a quantity point is a nan.
| xref:mp_units/lerp.adoc[`lerp`]
| Linear interpolation or extrapolation
| xref:mp_units/midpoint.adoc[`midpoint`]
| Computes the midpoint of two points
| xref:mp_units/value_cast-021.adoc[`value_cast`]
| Explicit cast of a quantity point's representation type
|===

== Description

An absolute quantity measured from an origin.

== Template Parameters

[cols=2]
|===
| Name
| Description
| *R*
| a reference of the quantity point providing all information about quantity properties
| *PO*
| a type that represents the origin point from which the quantity point is measured from
| *Rep*
| a type to be used to represent values of a quantity point
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#