Rerun C++ SDK
Loading...
Searching...
No Matches
variance.hpp
1// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
2// Based on "crates/build/re_type_definitions/rerun/components/variance.def.rs".
3
4#pragma once
5
6#include "../encodings/float64.hpp"
7#include "../result.hpp"
8
9#include <cstdint>
10#include <memory>
11
12namespace rerun::components {
13 /// **Component**: Variance of a scalar measurement, i.e. σ², in the units of the value squared.
14 ///
15 /// A value of `0` is a perfectly known value and draws no error band.
16 ///
17 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
18 ///
19 struct Variance {
21
22 public:
23 Variance() = default;
24
25 Variance(rerun::encodings::Float64 value_) : value(value_) {}
26
27 Variance& operator=(rerun::encodings::Float64 value_) {
28 value = value_;
29 return *this;
30 }
31
32 Variance(double value_) : value(value_) {}
33
34 Variance& operator=(double value_) {
35 value = value_;
36 return *this;
37 }
38
39 /// Cast to the underlying Float64 encoding
40 operator rerun::encodings::Float64() const {
41 return value;
42 }
43 };
44} // namespace rerun::components
45
46namespace rerun {
47 static_assert(sizeof(rerun::encodings::Float64) == sizeof(components::Variance));
48
49 /// \private
50 template <>
51 struct Loggable<components::Variance> {
52 static constexpr std::string_view ComponentType = "rerun.components.Variance";
53
54 /// Returns the arrow data type this type corresponds to.
55 static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
56 return Loggable<rerun::encodings::Float64>::arrow_data_type();
57 }
58
59 /// Serializes an array of `rerun::components::Variance` into an arrow array.
60 static Result<std::shared_ptr<arrow::Array>> to_arrow(
61 const components::Variance* instances, size_t num_instances
62 ) {
63 if (num_instances == 0) {
64 return Loggable<rerun::encodings::Float64>::to_arrow(nullptr, 0);
65 } else if (instances == nullptr) {
66 return rerun::Error(
67 ErrorCode::UnexpectedNullArgument,
68 "Passed array instances is null when num_elements> 0."
69 );
70 } else {
71 return Loggable<rerun::encodings::Float64>::to_arrow(
72 &instances->value,
73 num_instances
74 );
75 }
76 }
77 };
78} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
All built-in components. See Types in the Rerun manual.
Definition rerun.hpp:93
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:26
Component: Variance of a scalar measurement, i.e.
Definition variance.hpp:19
Encoding: A double-precision 64-bit IEEE 754 floating point number.
Definition float64.hpp:24