TensorKey.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 "open3d/utility/Console.h"

namespace open3d {
namespace core {

class Tensor;  // Avoids circular include

// TODO: refactor this to use utility::optional
class NoneType {};

extern NoneType None;

class TensorKey {
public:
    enum class TensorKeyMode { Index, Slice, IndexTensor };

    static TensorKey Index(int64_t index);

    static TensorKey Slice(int64_t start, int64_t stop, int64_t step);
    static TensorKey Slice(int64_t start, int64_t stop, NoneType step);
    static TensorKey Slice(int64_t start, NoneType stop, int64_t step);
    static TensorKey Slice(int64_t start, NoneType stop, NoneType step);
    static TensorKey Slice(NoneType start, int64_t stop, int64_t step);
    static TensorKey Slice(NoneType start, int64_t stop, NoneType step);
    static TensorKey Slice(NoneType start, NoneType stop, int64_t step);
    static TensorKey Slice(NoneType start, NoneType stop, NoneType step);

    static TensorKey IndexTensor(const Tensor& index_tensor);

    TensorKeyMode GetMode() const { return mode_; }

    int64_t GetIndex() const {
        AssertMode(TensorKeyMode::Index);
        return index_;
    }

    int64_t GetStart() const {
        AssertMode(TensorKeyMode::Slice);
        return start_;
    }

    int64_t GetStop() const {
        AssertMode(TensorKeyMode::Slice);
        return stop_;
    }

    int64_t GetStep() const {
        AssertMode(TensorKeyMode::Slice);
        return step_;
    }

    bool GetStartIsNone() const {
        AssertMode(TensorKeyMode::Slice);
        return start_is_none_;
    }

    bool GetStopIsNone() const {
        AssertMode(TensorKeyMode::Slice);
        return stop_is_none_;
    }

    bool GetStepIsNone() const {
        AssertMode(TensorKeyMode::Slice);
        return step_is_none_;
    }

    std::shared_ptr<Tensor> GetIndexTensor() const;

    TensorKey UpdateWithDimSize(int64_t dim_size) const;

    static TensorKey Slice(int64_t start,
                           int64_t stop,
                           int64_t step,
                           bool start_is_none,
                           bool stop_is_none,
                           bool step_is_none);

    std::string ToString() const;

protected:
    TensorKey(TensorKeyMode mode,
              int64_t index,
              int64_t start,
              int64_t stop,
              int64_t step,
              bool start_is_none,
              bool stop_is_none,
              bool step_is_none,
              const Tensor& index_tensor);

    void AssertMode(TensorKeyMode mode) const {
        if (mode != mode_) {
            utility::LogError("Wrong TensorKeyMode.");
        }
    }

    TensorKeyMode mode_;

public:
    int64_t index_ = 0;

    int64_t start_ = 0;
    int64_t stop_ = 0;
    int64_t step_ = 0;
    bool start_is_none_ = false;
    bool stop_is_none_ = false;
    bool step_is_none_ = false;

    std::shared_ptr<Tensor> index_tensor_;
};

}  // namespace core
}  // namespace open3d