1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
use std::borrow::Cow;
use std::sync::Arc;
use itertools::Itertools as _;
use re_chunk_store::{Chunk, LatestAtQuery, RangeQuery, UnitChunkShared};
use re_log_types::external::arrow2::array::Array as ArrowArray;
use re_log_types::hash::Hash64;
use re_query::{LatestAtResults, RangeResults};
use re_types_core::ComponentName;
use re_viewer_context::{DataResult, QueryContext, ViewContext};
use crate::DataResultQuery as _;
// ---
/// Wrapper that contains the results of a latest-at query with possible overrides.
///
/// Although overrides are never temporal, when accessed via the [`crate::RangeResultsExt`] trait
/// they will be merged into the results appropriately.
pub struct HybridLatestAtResults<'a> {
pub overrides: LatestAtResults,
pub results: LatestAtResults,
pub defaults: LatestAtResults,
pub ctx: &'a ViewContext<'a>,
pub query: LatestAtQuery,
pub data_result: &'a DataResult,
}
/// Wrapper that contains the results of a range query with possible overrides.
///
/// Although overrides are never temporal, when accessed via the [`crate::RangeResultsExt`] trait
/// they will be merged into the results appropriately.
#[derive(Debug)]
pub struct HybridRangeResults {
pub(crate) overrides: LatestAtResults,
pub(crate) results: RangeResults,
pub(crate) defaults: LatestAtResults,
}
impl<'a> HybridLatestAtResults<'a> {
/// Returns the [`UnitChunkShared`] for the specified [`re_types_core::Component`].
#[inline]
pub fn get(&self, component_name: impl Into<ComponentName>) -> Option<&UnitChunkShared> {
let component_name = component_name.into();
self.overrides
.get(&component_name)
.or_else(|| self.results.get(&component_name))
.or_else(|| self.defaults.get(&component_name))
}
pub fn fallback_raw(&self, component_name: ComponentName) -> Box<dyn ArrowArray> {
let query_context = QueryContext {
viewer_ctx: self.ctx.viewer_ctx,
target_entity_path: &self.data_result.entity_path,
archetype_name: None, // TODO(jleibs): Do we need this?
query: &self.query,
view_state: self.ctx.view_state,
view_ctx: Some(self.ctx),
};
self.data_result.best_fallback_for(
&query_context,
&self.ctx.visualizer_collection,
component_name,
)
}
/// Utility for retrieving the first instance of a component, ignoring defaults.
#[inline]
pub fn get_required_mono<C: re_types_core::Component>(&self) -> Option<C> {
self.get_required_instance(0)
}
/// Utility for retrieving the first instance of a component.
#[inline]
pub fn get_mono<C: re_types_core::Component>(&self) -> Option<C> {
self.get_instance(0)
}
/// Utility for retrieving the first instance of a component.
#[inline]
pub fn get_mono_with_fallback<C: re_types_core::Component + Default>(&self) -> C {
self.get_instance_with_fallback(0)
}
/// Utility for retrieving a single instance of a component, not checking for defaults.
///
/// If overrides or defaults are present, they will only be used respectively if they have a component at the specified index.
#[inline]
pub fn get_required_instance<C: re_types_core::Component>(&self, index: usize) -> Option<C> {
self.overrides.component_instance::<C>(index).or_else(||
// No override -> try recording store instead
self.results.component_instance::<C>(index))
}
/// Utility for retrieving a single instance of a component.
///
/// If overrides or defaults are present, they will only be used respectively if they have a component at the specified index.
#[inline]
pub fn get_instance<C: re_types_core::Component>(&self, index: usize) -> Option<C> {
self.get_required_instance(index).or_else(|| {
// No override & no store -> try default instead
self.defaults.component_instance::<C>(index)
})
}
/// Utility for retrieving a single instance of a component.
///
/// If overrides or defaults are present, they will only be used respectively if they have a component at the specified index.
#[inline]
pub fn get_instance_with_fallback<C: re_types_core::Component + Default>(
&self,
index: usize,
) -> C {
self.get_instance(index)
.or_else(|| {
// No override, no store, no default -> try fallback instead
let raw_fallback = self.fallback_raw(C::name());
C::from_arrow(raw_fallback.as_ref())
.ok()
.and_then(|r| r.first().cloned())
})
.unwrap_or_default()
}
}
pub enum HybridResults<'a> {
LatestAt(LatestAtQuery, HybridLatestAtResults<'a>),
// Boxed because of size difference between variants
Range(RangeQuery, Box<HybridRangeResults>),
}
impl<'a> HybridResults<'a> {
pub fn query_result_hash(&self) -> Hash64 {
re_tracing::profile_function!();
// TODO(andreas): We should be able to do better than this and determine hashes for queries on the fly.
match self {
Self::LatestAt(_, r) => {
let mut indices = Vec::with_capacity(
r.defaults.components.len()
+ r.overrides.components.len()
+ r.results.components.len(),
);
indices.extend(
r.defaults
.components
.values()
.filter_map(|chunk| chunk.row_id()),
);
indices.extend(
r.overrides
.components
.values()
.filter_map(|chunk| chunk.row_id()),
);
indices.extend(
r.results
.components
.values()
.filter_map(|chunk| chunk.row_id()),
);
Hash64::hash(&indices)
}
Self::Range(_, r) => {
let mut indices = Vec::with_capacity(
r.defaults.components.len()
+ r.overrides.components.len()
+ r.results.components.len(), // Don't know how many results per component.
);
indices.extend(
r.defaults
.components
.values()
.filter_map(|chunk| chunk.row_id()),
);
indices.extend(
r.overrides
.components
.values()
.filter_map(|chunk| chunk.row_id()),
);
indices.extend(
r.results
.components
.iter()
.flat_map(|(component_name, chunks)| {
chunks
.iter()
.flat_map(|chunk| chunk.component_row_ids(component_name))
}),
);
Hash64::hash(&indices)
}
}
}
}
// ---
impl<'a> From<(LatestAtQuery, HybridLatestAtResults<'a>)> for HybridResults<'a> {
#[inline]
fn from((query, results): (LatestAtQuery, HybridLatestAtResults<'a>)) -> Self {
Self::LatestAt(query, results)
}
}
impl<'a> From<(RangeQuery, HybridRangeResults)> for HybridResults<'a> {
#[inline]
fn from((query, results): (RangeQuery, HybridRangeResults)) -> Self {
Self::Range(query, Box::new(results))
}
}
/// Extension traits to abstract query result handling for all spatial space views.
///
/// Also turns all results into range results, so that views only have to worry about the ranged
/// case.
pub trait RangeResultsExt {
/// Returns component data for the given component, ignores default data if the result
/// distinguishes them.
///
/// For results that are aware of the blueprint, only overrides & store results will
/// be considered.
/// Defaults have no effect.
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>>;
/// Returns component data for the given component or an empty array.
///
/// For results that are aware of the blueprint, overrides, store results, and defaults will be
/// considered.
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]>;
/// Returns a zero-copy iterator over all the results for the given `(timeline, component)` pair.
///
/// Call one of the following methods on the returned [`HybridResultsChunkIter`]:
/// * [`HybridResultsChunkIter::primitive`]
/// * [`HybridResultsChunkIter::primitive_array`]
/// * [`HybridResultsChunkIter::string`]
fn iter_as(
&self,
timeline: Timeline,
component_name: ComponentName,
) -> HybridResultsChunkIter<'_> {
let chunks = self.get_optional_chunks(&component_name);
HybridResultsChunkIter {
chunks,
timeline,
component_name,
}
}
}
impl RangeResultsExt for LatestAtResults {
#[inline]
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>> {
self.get(component_name)
.cloned()
.map(|chunk| Cow::Owned(vec![Arc::unwrap_or_clone(chunk.into_chunk())]))
}
#[inline]
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]> {
self.get(component_name).cloned().map_or_else(
|| Cow::Owned(vec![]),
|chunk| Cow::Owned(vec![Arc::unwrap_or_clone(chunk.into_chunk())]),
)
}
}
impl RangeResultsExt for RangeResults {
#[inline]
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>> {
self.get_required(component_name).ok().map(Cow::Borrowed)
}
#[inline]
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]> {
Cow::Borrowed(self.get(component_name).unwrap_or_default())
}
}
impl RangeResultsExt for HybridRangeResults {
#[inline]
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>> {
if let Some(unit) = self.overrides.get(component_name) {
// Because this is an override we always re-index the data as static
let chunk = Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed();
Some(Cow::Owned(vec![chunk]))
} else {
self.results.get_required_chunks(component_name)
}
}
#[inline]
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]> {
re_tracing::profile_function!();
if let Some(unit) = self.overrides.get(component_name) {
// Because this is an override we always re-index the data as static
let chunk = Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed();
Cow::Owned(vec![chunk])
} else {
re_tracing::profile_scope!("defaults");
// NOTE: Because this is a range query, we always need the defaults to come first,
// since range queries don't have any state to bootstrap from.
let defaults = self.defaults.get(component_name).map(|unit| {
// Because this is an default from the blueprint we always re-index the data as static
Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed()
});
let chunks = self.results.get_optional_chunks(component_name);
// TODO(cmc): this `collect_vec()` sucks, let's keep an eye on it and see if it ever
// becomes an issue.
Cow::Owned(
defaults
.into_iter()
.chain(chunks.iter().cloned())
.collect_vec(),
)
}
}
}
impl<'a> RangeResultsExt for HybridLatestAtResults<'a> {
#[inline]
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>> {
if let Some(unit) = self.overrides.get(component_name) {
// Because this is an override we always re-index the data as static
let chunk = Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed();
Some(Cow::Owned(vec![chunk]))
} else {
self.results.get_required_chunks(component_name)
}
}
#[inline]
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]> {
if let Some(unit) = self.overrides.get(component_name) {
// Because this is an override we always re-index the data as static
let chunk = Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed();
Cow::Owned(vec![chunk])
} else {
let chunks = self
.results
.get_optional_chunks(component_name)
.iter()
// NOTE: Since this is a latest-at query that is being coerced into a range query, we
// need to make sure that every secondary column has an index smaller then the primary column
// (we use `(TimeInt::STATIC, RowId::ZERO)`), otherwise range zipping would yield unexpected
// results.
.map(|chunk| chunk.clone().into_static().zeroed())
.collect_vec();
// If the data is not empty, return it.
if !chunks.is_empty() {
return Cow::Owned(chunks);
}
// Otherwise try to use the default data.
let Some(unit) = self.defaults.get(component_name) else {
return Cow::Owned(Vec::new());
};
// Because this is an default from the blueprint we always re-index the data as static
let chunk = Arc::unwrap_or_clone(unit.clone().into_chunk())
.into_static()
.zeroed();
Cow::Owned(vec![chunk])
}
}
}
impl<'a> RangeResultsExt for HybridResults<'a> {
#[inline]
fn get_required_chunks(&self, component_name: &ComponentName) -> Option<Cow<'_, [Chunk]>> {
match self {
Self::LatestAt(_, results) => results.get_required_chunks(component_name),
Self::Range(_, results) => results.get_required_chunks(component_name),
}
}
#[inline]
fn get_optional_chunks(&self, component_name: &ComponentName) -> Cow<'_, [Chunk]> {
match self {
Self::LatestAt(_, results) => results.get_optional_chunks(component_name),
Self::Range(_, results) => results.get_optional_chunks(component_name),
}
}
}
// ---
use re_chunk::{ChunkComponentIterItem, RowId, TimeInt, Timeline};
use re_chunk_store::external::{re_chunk, re_chunk::external::arrow2};
/// The iterator type backing [`HybridResults::iter_as`].
pub struct HybridResultsChunkIter<'a> {
chunks: Cow<'a, [Chunk]>,
timeline: Timeline,
component_name: ComponentName,
}
impl<'a> HybridResultsChunkIter<'a> {
/// Iterate as indexed deserialized batches.
///
/// See [`Chunk::iter_component`] for more information.
pub fn component<C: re_types_core::Component>(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), ChunkComponentIterItem<C>)> + 'a {
self.chunks.iter().flat_map(move |chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_component::<C>(),
)
})
}
/// Iterate as indexed primitives.
///
/// See [`Chunk::iter_primitive`] for more information.
pub fn primitive<T: arrow2::types::NativeType>(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), &'a [T])> + 'a {
self.chunks.iter().flat_map(move |chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_primitive::<T>(&self.component_name)
)
})
}
/// Iterate as indexed primitive arrays.
///
/// See [`Chunk::iter_primitive_array`] for more information.
pub fn primitive_array<const N: usize, T: arrow2::types::NativeType>(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), &'a [[T; N]])> + 'a
where
[T; N]: bytemuck::Pod,
{
self.chunks.iter().flat_map(move |chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_primitive_array::<N, T>(&self.component_name)
)
})
}
/// Iterate as indexed list of primitive arrays.
///
/// See [`Chunk::iter_primitive_array_list`] for more information.
pub fn primitive_array_list<const N: usize, T: arrow2::types::NativeType>(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), Vec<&'a [[T; N]]>)> + 'a
where
[T; N]: bytemuck::Pod,
{
self.chunks.iter().flat_map(move |chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_primitive_array_list::<N, T>(&self.component_name)
)
})
}
/// Iterate as indexed UTF-8 strings.
///
/// See [`Chunk::iter_string`] for more information.
pub fn string(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), Vec<re_types_core::ArrowString>)> + 'a {
self.chunks.iter().flat_map(|chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_string(&self.component_name)
)
})
}
/// Iterate as indexed buffers.
///
/// See [`Chunk::iter_buffer`] for more information.
pub fn buffer<T: arrow2::types::NativeType>(
&'a self,
) -> impl Iterator<Item = ((TimeInt, RowId), Vec<re_types_core::ArrowBuffer<T>>)> + 'a {
self.chunks.iter().flat_map(|chunk| {
itertools::izip!(
chunk.iter_component_indices(&self.timeline, &self.component_name),
chunk.iter_buffer(&self.component_name)
)
})
}
}