TensorCheck.h File Reference

(5c982c7 (Thu Apr 18 12:15:13 2024 -0700))

#include "open3d/Macro.h"
#include "open3d/core/Device.h"
#include "open3d/core/Dtype.h"
#include "open3d/core/Tensor.h"

Go to the source code of this file.

Namespaces
	open3d
	open3d::core
	open3d::core::tensor_check

Macros
#define	AssertTensorDtype(tensor, ...)
#define	AssertTensorDtypes(tensor, ...)
#define	AssertTensorDevice(tensor, ...)
#define	AssertTensorShape(tensor, ...)

Functions
void	open3d::core::tensor_check::AssertTensorDtype_ (const char *file, int line, const char *function, const Tensor &tensor, const Dtype &dtype)
void	open3d::core::tensor_check::AssertTensorDtypes_ (const char *file, int line, const char *function, const Tensor &tensor, const std::vector< Dtype > &dtypes)
void	open3d::core::tensor_check::AssertTensorDevice_ (const char *file, int line, const char *function, const Tensor &tensor, const Device &device)
void	open3d::core::tensor_check::AssertTensorShape_ (const char *file, int line, const char *function, const Tensor &tensor, const DynamicSizeVector &shape)

Macro Definition Documentation

AssertTensorDevice

#define AssertTensorDevice	(		tensor,
			...
	)

Value:

    tensor_check::AssertTensorDevice_(                                     \
            __FILE__, __LINE__, static_cast<const char*>(OPEN3D_FUNCTION), \
            tensor, __VA_ARGS__)

Assert Tensor's device is the same as the expected device. When an error occurs, the corresponding file name, line number and function name will be printed in the error message.

Example: check that the tensor has device CUDA:0 core::AssertTensorDevice(tensor, core::Device("CUDA:0"));

AssertTensorDtype

#define AssertTensorDtype	(		tensor,
			...
	)

Value:

    tensor_check::AssertTensorDtype_(                                      \
            __FILE__, __LINE__, static_cast<const char*>(OPEN3D_FUNCTION), \
            tensor, __VA_ARGS__)

Assert Tensor's dtype is the same as the expected dtype. When an error occurs, the corresponding file name, line number and function name will be printed in the error message.

Example: check that the tensor has dtype Float32 core::AssertTensorDtype(tensor, core::Float32);

AssertTensorDtypes

#define AssertTensorDtypes	(		tensor,
			...
	)

Value:

    tensor_check::AssertTensorDtypes_(                                     \
            __FILE__, __LINE__, static_cast<const char*>(OPEN3D_FUNCTION), \
            tensor, __VA_ARGS__)

Assert Tensor's dtype is among one of the expected dtypes. When an error occurs, the corresponding file name, line number and function name will be printed in the error message.

Example: check that the tensor has dtype Float32 or Float64 core::AssertTensorDtypes(tensor, {core::Float32, core::Float64});

AssertTensorShape

#define AssertTensorShape	(		tensor,
			...
	)

Value:

    tensor_check::AssertTensorShape_(                                      \
            __FILE__, __LINE__, static_cast<const char*>(OPEN3D_FUNCTION), \
            tensor, __VA_ARGS__)

Assert Tensor's shape is the same as the expected shape. AssertTensorShape takes a shape (SizeVector) or dynamic shape (DynamicSizeVector). When an error occurs, the corresponding file name, line number and function name will be printed in the error message.

Example: check that the tensor has shape {100, 3} core::AssertTensorShape(tensor, {100, 3});

Example: check that the tensor has shape {N, 3} core::AssertTensorShape(tensor, {utility::nullopt, 3});