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

Returns the default point origin for a reference

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Reference-0ba.adoc[Reference] R>
[[nodiscard]]
consteval
xref:mp_units/PointOriginFor.adoc[PointOriginFor<get_quantity_spec(R{})>] auto
default_point_origin(R r);
----

== Description

If the reference's unit defines its own point origin, that origin is returned. Otherwise, the natural point origin of the reference's quantity specification is used.

== Return Value

the default point origin associated with `R`

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Template Parameters

[cols="1,4"]
|===
| Name| Description
| *R*
| reference type for which the default point origin is requested
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *r*
| reference instance for which the default point origin is requested
|===


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