Device.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <string>
#include <vector>
 
namespace open3d {
namespace core {
 
class Device {
public:
    enum class DeviceType {
        CPU = 0,
        CUDA = 1,
        SYCL = 2,  // SYCL gpu_selector_v.
    };
 
    Device() = default;
 
    explicit Device(DeviceType device_type, int device_id);
 
    explicit Device(const std::string& device_type, int device_id);
 
    Device(const std::string& device_str);
 
    bool operator==(const Device& other) const;
 
    bool operator!=(const Device& other) const;
 
    bool operator<(const Device& other) const;
 
    inline bool IsCPU() const { return device_type_ == DeviceType::CPU; }
 
    inline bool IsCUDA() const { return device_type_ == DeviceType::CUDA; }
 
    inline bool IsSYCL() const { return device_type_ == DeviceType::SYCL; }
 
    std::string ToString() const;
 
    inline DeviceType GetType() const { return device_type_; }
 
    inline int GetID() const { return device_id_; }
 
    bool IsAvailable() const;
 
    static std::vector<Device> GetAvailableDevices();
 
    static std::vector<Device> GetAvailableCPUDevices();
 
    static std::vector<Device> GetAvailableCUDADevices();
 
    static std::vector<Device> GetAvailableSYCLDevices();
 
    static void PrintAvailableDevices();
 
protected:
    DeviceType device_type_ = DeviceType::CPU;
    int device_id_ = 0;
};
 
class IsDevice {
public:
    IsDevice() = default;
    virtual ~IsDevice() = default;
 
    virtual core::Device GetDevice() const = 0;
 
    inline bool IsCPU() const {
        return GetDevice().GetType() == Device::DeviceType::CPU;
    }
 
    inline bool IsCUDA() const {
        return GetDevice().GetType() == Device::DeviceType::CUDA;
    }
 
    inline bool IsSYCL() const {
        return GetDevice().GetType() == Device::DeviceType::SYCL;
    }
};
 
}  // namespace core
}  // namespace open3d
 
namespace std {
template <>
struct hash<open3d::core::Device> {
    std::size_t operator()(const open3d::core::Device& device) const {
        return std::hash<std::string>{}(device.ToString());
    }
};
 
template <>
struct less<open3d::core::Device> {
    bool operator()(const open3d::core::Device& lhs,
                    const open3d::core::Device& rhs) const {
        return lhs.ToString() < rhs.ToString();
    }
};
}  // namespace std