mindspore2022/mindspore/ccsrc/minddata/dataset/engine/gnn/node.h

/**
 * Copyright 2020 Huawei Technologies Co., Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_GNN_NODE_H_
#define MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_GNN_NODE_H_

#include <memory>
#include <unordered_map>
#include <vector>

#include "minddata/dataset/engine/gnn/feature.h"
#include "minddata/dataset/util/status.h"

namespace mindspore {
namespace dataset {
namespace gnn {
using NodeType = int8_t;
using NodeIdType = int32_t;
using WeightType = float;
using EdgeIdType = int32_t;

constexpr NodeIdType kDefaultNodeId = -1;

class Edge;

class Node {
 public:
  // Constructor
  // @param NodeIdType id - node id
  // @param NodeType type - node type
  // @param WeightType type - node weight
  Node(NodeIdType id, NodeType type, WeightType weight) : id_(id), type_(type), weight_(weight) {}

  virtual ~Node() = default;

  // @return NodeIdType - Returned node id
  NodeIdType id() const { return id_; }

  // @return NodeIdType - Returned node type
  NodeType type() const { return type_; }

  // @return WeightType - Returned node weight
  WeightType weight() const { return weight_; }

  // Get the feature of a node
  // @param FeatureType feature_type - type of feature
  // @param std::shared_ptr<Feature> *out_feature - Returned feature
  // @return Status The status code returned
  virtual Status GetFeatures(FeatureType feature_type, std::shared_ptr<Feature> *out_feature) = 0;

  // Get the all neighbors of a node
  // @param NodeType neighbor_type - type of neighbor
  // @param std::vector<NodeIdType> *out_neighbors - Returned neighbors id
  // @return Status The status code returned
  virtual Status GetAllNeighbors(NodeType neighbor_type, std::vector<NodeIdType> *out_neighbors,
                                 bool exclude_itself = false) = 0;

  // Get the sampled neighbors of a node
  // @param NodeType neighbor_type - type of neighbor
  // @param int32_t samples_num - Number of neighbors to be acquired
  // @param SamplingStrategy strategy - Sampling strategy
  // @param std::vector<NodeIdType> *out_neighbors - Returned neighbors id
  // @return Status The status code returned
  virtual Status GetSampledNeighbors(NodeType neighbor_type, int32_t samples_num, SamplingStrategy strategy,
                                     std::vector<NodeIdType> *out_neighbors) = 0;

  // Add neighbor of node
  // @param std::shared_ptr<Node> node -
  // @return Status The status code returned
  virtual Status AddNeighbor(const std::shared_ptr<Node> &node, const WeightType &weight) = 0;

  // Add adjacent node and relative edge for source node
  // @param std::shared_ptr<Node> node - the node to be inserted into adjacent table
  // @param std::shared_ptr<Edge> edge - the edge related to the adjacent node of source node
  // @return Status - The status code that indicate the result of function execution
  virtual Status AddAdjacent(const std::shared_ptr<Node> &node, const std::shared_ptr<Edge> &edge) = 0;

  // Get relative connecting edge of adjacent node by node id
  // @param NodeIdType - The id of adjacent node to be processed
  // @param std::shared_ptr<EdgeIdType> - The id of relative connecting edge
  // @return Status - The status code that indicate the result of function execution
  virtual Status GetEdgeByAdjNodeId(const NodeIdType &adj_node_id, EdgeIdType **out_edge_id) = 0;

  // Update feature of node
  // @param std::shared_ptr<Feature> feature -
  // @return Status The status code returned
  virtual Status UpdateFeature(const std::shared_ptr<Feature> &feature) = 0;

 protected:
  NodeIdType id_;
  NodeType type_;
  WeightType weight_;
};
}  // namespace gnn
}  // namespace dataset
}  // namespace mindspore
#endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_ENGINE_GNN_NODE_H_