c10::Device Struct Reference

Represents a a compute device on which a tensor is located. More...

#include <Device.h>

Public Types
using	Type = DeviceType

Public Member Functions
	Device (DeviceType type, DeviceIndex index=-1)
	Constructs a new Device from a DeviceType and an optional device index. More...
	Device (const std::string &device_string)
	Constructs a Device from a string description, for convenience. More...
bool	operator== (const Device &other) const noexcept
	Returns true if the type and index of this Device matches that of other. More...
bool	operator!= (const Device &other) const noexcept
	Returns true if the type or index of this Device differs from that of other. More...
void	set_index (DeviceIndex index)
	Sets the device index.
DeviceType	type () const noexcept
	Returns the type of device this is.
DeviceIndex	index () const noexcept
	Returns the optional index.
bool	has_index () const noexcept
	Returns true if the device has a non-default index.
bool	is_cuda () const noexcept
	Return true if the device is of CUDA type.
bool	is_cpu () const noexcept
	Return true if the device is of CPU type.

Detailed Description

Represents a a compute device on which a tensor is located.

A device is uniquely identified by a type, which specifies the type of machine it is (e.g. CPU or CUDA GPU), and a device index or ordinal, which identifies the specific compute device when there is more than one of a certain type. The device index is optional, and in its defaulted state represents (abstractly) "the current device". Further, there are two constraints on the value of the device index, if one is explicitly stored:

1. A negative index represents the current device, a non-negative index represents a specific, concrete device,
2. When the device type is CPU, the device index must be zero.

Definition at line 30 of file Device.h.

Constructor & Destructor Documentation

c10::Device::Device ( DeviceType  type, DeviceIndex  index = -1  )

inline

Constructs a new Device from a DeviceType and an optional device index.

Definition at line 35 of file Device.h.

c10::Device::Device

(

const std::string &

device_string

)

Constructs a Device from a string description, for convenience.

The string supplied must follow the following schema: (cpu|cuda)[:<device-index>] where cpu or cuda specifies the device type, and :<device-index> optionally specifies a device index.

Definition at line 71 of file Device.cpp.

Member Function Documentation

bool c10::Device::operator!= ( const Device &  other ) const

inlinenoexcept

Returns true if the type or index of this Device differs from that of other.

Definition at line 55 of file Device.h.

bool c10::Device::operator== ( const Device &  other ) const

inlinenoexcept

Returns true if the type and index of this Device matches that of other.

Definition at line 49 of file Device.h.

---

The documentation for this struct was generated from the following files:

• c10/core/Device.h
• c10/core/Device.cpp