TensorListMap.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2018 www.open3d.org
//
// 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.
// ----------------------------------------------------------------------------

#pragma once

#include <string>
#include <unordered_map>

#include "open3d/core/TensorList.h"

namespace open3d {
namespace t {
namespace geometry {

class TensorListMap : public std::unordered_map<std::string, core::TensorList> {
public:
    TensorListMap(const std::string& primary_key)
        : std::unordered_map<std::string, core::TensorList>(),
          primary_key_(primary_key) {}

    TensorListMap(const std::string& primary_key,
                  const std::unordered_map<std::string, core::TensorList>&
                          map_keys_to_tensorlists)
        : std::unordered_map<std::string, core::TensorList>(),
          primary_key_(primary_key) {
        Assign(map_keys_to_tensorlists);
    }

    TensorListMap() : TensorListMap("Undefined") {
        utility::LogError("Please construct TensorListMap with a primary key.");
    }

    void Assign(const std::unordered_map<std::string, core::TensorList>&
                        map_keys_to_tensorlists);

    void SynchronizedPushBack(
            const std::unordered_map<std::string, core::Tensor>&
                    map_keys_to_tensors);

    std::string GetPrimaryKey() const { return primary_key_; }

    bool IsSizeSynchronized() const;

    void AssertSizeSynchronized() const;

    bool Contains(const std::string& key) const { return count(key) != 0; }

private:
    void AssertTensorMapSameKeys(
            const std::unordered_map<std::string, core::Tensor>&
                    map_keys_to_tensors) const;

    void AssertTensorMapSameDevice(
            const std::unordered_map<std::string, core::Tensor>&
                    map_keys_to_tensors) const;

    int64_t GetPrimarySize() const { return at(primary_key_).GetSize(); }

    core::Device GetPrimaryDevice() const {
        return at(primary_key_).GetDevice();
    }

    std::string primary_key_;
};

}  // namespace geometry
}  // namespace t
}  // namespace open3d