ufo::Confidence Struct Reference

Represents a confidence score as a single float value. More...

#include <lib/core/include/ufo/core/confidence.hpp>

Public Types
using	value_type = float
	Underlying scalar type.

Public Member Functions
constexpr	operator value_type () const noexcept
	Implicitly converts to the underlying scalar type.

Public Attributes
value_type	confidence {}
	The confidence score (e.g., a value in [0, 1]).

Friends
constexpr auto	operator<=> (Confidence lhs, Confidence rhs) noexcept=default
	Three-way comparison (total order on the underlying float).
constexpr bool	operator== (Confidence lhs, Confidence rhs) noexcept=default
	Equality comparison.

Detailed Description

Represents a confidence score as a single float value.

Confidence is a lightweight, trivially-copyable value type used as the confidence or score component of Semantic. It pairs with Label to form a complete semantic annotation: a class ID and a measure of certainty for that class.

It is implicitly convertible to and from float, fully ordered via <=>, and supports std::ostream streaming and std::format.

Definition at line 66 of file confidence.hpp.

Member Typedef Documentation

value_type

using ufo::Confidence::value_type = float

Underlying scalar type.

Definition at line 70 of file confidence.hpp.

Member Function Documentation

operator value_type()

constexpr ufo::Confidence::operator value_type ( ) const

inlineconstexprnoexcept

Implicitly converts to the underlying scalar type.

Returns

The confidence score as a float.

Allows Confidence to be used wherever a float is expected.

Definition at line 84 of file confidence.hpp.

Friends And Related Symbol Documentation

operator<=>

constexpr auto operator<=> ( Confidence  lhs, Confidence  rhs  )

friend

Three-way comparison (total order on the underlying float).

Parameters

[in]	lhs	Left operand.
[in]	rhs	Right operand.

Returns

Comparison result.

operator==

constexpr bool operator== ( Confidence  lhs, Confidence  rhs  )

friend

Equality comparison.

Parameters

[in]	lhs	Left operand.
[in]	rhs	Right operand.

Returns

True if both confidence scores are equal.

Member Data Documentation

confidence

value_type ufo::Confidence::confidence {}

The confidence score (e.g., a value in [0, 1]).

Definition at line 75 of file confidence.hpp.

---

The documentation for this struct was generated from the following file:

• lib/core/include/ufo/core/confidence.hpp