From 994068268dd6a26c678afde549054989bce6ed89 Mon Sep 17 00:00:00 2001 From: Tim Shen Date: Thu, 2 Aug 2018 00:21:12 +0000 Subject: [PATCH] [ADT] Add some documentation for GraphTraits. Summary: Add some context for GraphTraits. Reviewers: dblaikie, asbirlea Subscribers: sanjoy, jlebar, bixia, dexonsmith, llvm-commits Differential Revision: https://reviews.llvm.org/D50120 llvm-svn: 338660 --- llvm/include/llvm/ADT/GraphTraits.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/llvm/include/llvm/ADT/GraphTraits.h b/llvm/include/llvm/ADT/GraphTraits.h index 27c647f4bbbd9..d39b50fdc488a 100644 --- a/llvm/include/llvm/ADT/GraphTraits.h +++ b/llvm/include/llvm/ADT/GraphTraits.h @@ -25,6 +25,13 @@ namespace llvm { // GraphTraits - This class should be specialized by different graph types... // which is why the default version is empty. // +// This template evolved from supporting `BasicBlock` to also later supporting +// more complex types (e.g. CFG and DomTree). +// +// GraphTraits can be used to create a view over a graph interpreting it +// differently without requiring a copy of the original graph. This could +// be achieved by carrying more data in NodeRef. See LoopBodyTraits for one +// example. template struct GraphTraits { // Elements to provide: