/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roccv/checkouts/latest/include/common/validation_helpers.hpp File Reference

3 min read time

Applies to Linux

• include
• common

Macros

validation_helpers.hpp File Reference

#include <algorithm>
#include <vector>
#include "core/tensor.hpp"

Go to the source code of this file.

Macros
#define	CHECK_TENSOR_COMPARISON(comparison)
	Used for generic tensor validation comparisons. For example: (input.layout() == output.layout()). More...
#define	CHECK_TENSOR_DATATYPES(tensor, ...)
	Validates whether a tensor's datatype is supported based on a list of provided datatypes. More...
#define	CHECK_TENSOR_DEVICE(tensor, tensor_device)
	Validates whether a tensor is located on a specified device. More...
#define	CHECK_TENSOR_LAYOUT(tensor, ...)
	Validates whether a tensor's layout is supported, based on a list of provided supported layouts. More...

Macro Definition Documentation

◆ CHECK_TENSOR_COMPARISON

#define CHECK_TENSOR_COMPARISON

(

comparison

)

Value:

if (!(comparison)) { \

throw roccv::Exception("Tensor check failed: " #comparison, eStatusType::INVALID_COMBINATION); \

}

roccv::Exception

Definition: exception.hpp:31

Used for generic tensor validation comparisons. For example: (input.layout() == output.layout()).

◆ CHECK_TENSOR_DATATYPES

#define CHECK_TENSOR_DATATYPES	(		tensor,
			...
	)

Value:

do { \

std::vector<eDataType> v{__VA_ARGS__}; \

if (std::find(v.begin(), v.end(), tensor.dtype().etype()) == v.end()) { \

throw roccv::Exception("Unsupported data type: " #tensor, eStatusType::NOT_IMPLEMENTED); \

} \

} while (0);

Validates whether a tensor's datatype is supported based on a list of provided datatypes.

◆ CHECK_TENSOR_DEVICE

#define CHECK_TENSOR_DEVICE	(		tensor,
			tensor_device
	)

Value:

if (tensor.device() != tensor_device) { \

throw roccv::Exception("Invalid tensor " #tensor \

": Ensure that this tensor is allocated on the proper device.", \

eStatusType::INVALID_OPERATION); \

}

Validates whether a tensor is located on a specified device.

Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

◆ CHECK_TENSOR_LAYOUT

#define CHECK_TENSOR_LAYOUT	(		tensor,
			...
	)

Value:

do { \

std::vector<eTensorLayout> v{__VA_ARGS__}; \

if (std::find(v.begin(), v.end(), tensor.layout().elayout()) == v.end()) { \

throw roccv::Exception("Unsupported tensor layout: " #tensor, eStatusType::INVALID_COMBINATION); \

} \

} while (0);

Validates whether a tensor's layout is supported, based on a list of provided supported layouts.