C++のコードでの関数の構造について

Question

C++初心者です。下のコードで「yolov3.hpp」の

std::vector<YOLOv3Result> yolov3_post_process()

のコードの意味が理解できません。

理解できない点の主な点
1. 返り値にstd::vectorを値として持つはずですが、返り値が書いてない（実際の使用場面では返り値がある）

results = xilinx::ai::yolov3_post_process(

2.YOLOv3Result型のstd::vectorを返り値に持つ関数なのかどうかわからない。関数だとしたらどうゆう構造、使い方でどのような意味の返り値を返してるのでしょか？

もろもろ含めてこのyolov3_post_process()がどのように返り値を返す構造になってるのか理解できません。このコードのyolov3_post_process()がどのような使い方をされているか教えていただけないでしょうか？

yolov3.hpp

YOLOv3Result yolov3_post_process(
const std::vector<vitis::ai::library::InputTensor>& input_tensors,
const std::vector<vitis::ai::library::OutputTensor>& output_tensors,
const vitis::ai::proto::DpuModelParam& config, const int w, const int h);

std::vector<YOLOv3Result> yolov3_post_process(
const std::vector<vitis::ai::library::InputTensor>& input_tensors,
const std::vector<vitis::ai::library::OutputTensor>& output_tensors,
const vitis::ai::proto::DpuModelParam& config, const std::vector<int> & w, 
const std::vector<int> &h);
}  // namespace ai
} 

使用場面のコード
demo_yolov3_tiny.cpp

#include <xilinx/ai/nnpp/yolov3.hpp>
const auto results = xilinx::ai::yolov3_post_process(
                input_tensor, output_tensor, dpu_config, ORIG_WIDTH, ORIG_HEIGHT);

Answer 1

これは関数プロトタイプです。
関数プロトタイプ

この関数をどのように呼び出すかだけが示されており、実際の定義(関数の中身)はまた別にあります。

.hpp はヘッダファイルで、通常このような宣言ばかりが主に書かれます。.cpp という拡張子のファイルを探してみてください。もしかしたらソースは提供されていなくて、コンパイル済みかもしれません。

追記

2.YOLOv3Result型のstd::vectorを返り値に持つ関数なのかどうかわからない。関数だとしたらどうゆう構造、使い方でどのような意味の返り値を返してるのでしょか？

ここに yolov3_post_process の宣言は二つあります。これは同名で引数や戻り値の異なる関数が(少なくとも)二つあることを示します。このように、一つのクラスに同名のメソッドを複数作ることをオーバーロードと呼びます。これらは名前は同じですが、異なった関数で、引数の数や種類で呼び分けます。

片方は YOLOv3Result が戻り値で、もう片方は std::vector<YOLOv3Result> が戻り値です。
std::vector<T> は配列の上等なものと思ってください。つまり片方は YOLOv3Result を一つしか返さないが、もう片方は複数返すということです。

Comments

[trafalbad]

わかりやすい回答ありがとうございます

Answer 2

そのライブラリについてはわからないですが、C++ の構文の話なので、回答します。

1. 返り値にstd::vectorを値として持つはずですが、返り値が書いてない（実際の使用場面では返り値がある）

これは関数の定義ではなく、関数の宣言です。
通常はヘッダーファイル (.h または .hpp) に書きます。)

C言語入門 - 関数のプロトタイプ宣言 - Webkaru

もろもろ含めてこのyolov3_post_process()がどのように返り値を返す構造になってるのか理解できません。

YOLOv3Result 構造体の定義は以下にありますね。
検出した矩形の一覧と推論に使用した画像の幅及び高さをメンバ変数として持っています。

Vitis-AI/yolov3.hpp at master · Xilinx/Vitis-AI

struct YOLOv3Result {
  int width;
  int height;
  struct BoundingBox {
    int label;
    float score;
    float x;
    float y;
    float width;
    float height;
  };
  std::vector<BoundingBox> bboxes;
};

これを踏まえて以下を見てみます。

YOLOv3Result yolov3_post_process(
const std::vector<vitis::ai::library::InputTensor>& input_tensors,
const std::vector<vitis::ai::library::OutputTensor>& output_tensors,
const vitis::ai::proto::DpuModelParam& config, const int w, const int h);

std::vector<YOLOv3Result> yolov3_post_process(
const std::vector<vitis::ai::library::InputTensor>& input_tensors,
const std::vector<vitis::ai::library::OutputTensor>& output_tensors,
const vitis::ai::proto::DpuModelParam& config, const std::vector<int> & w, 
const std::vector<int> &h);
}  // namespace ai
} 

yolov3_post_process() は引数の違いによりオーバーロードが2つあります。
異なるのは以下の推論に使用した画像の幅及び高さを指定している部分です。

const int w, const int h
const std::vector<int> & w, const std::vector<int> &h

各画像の幅及び高さがそれぞれ異なる場合は YOLOv3Result の一覧、全部同じなら YOLOv3Result を返す関数が選ばれるようになっています。

YOLOv3Result yolov3_post_process(...) は全部の画像が同じ大きさの場合の後処理を行う関数、std::vector<YOLOv3Result> yolov3_post_process() は各画像の大きさが異なる場合の後処理を行う関数と考えられます。

Comments

[trafalbad]

わかりやすい回答ありがとうございます