<div dir="ltr">They're perfect. That's a really handy builder. Thanks!</div><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Nov 8, 2013 at 8:02 PM, NAKAMURA Takumi <span dir="ltr"><<a href="mailto:geek4civic@gmail.com" target="_blank">geek4civic@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Lang, could you plase confirm if my updates were reasonable?<br>
<br>
FYI, you can see -Wdocumentation enbled builder in<br>
<a href="http://bb.pgr.jp/builders/clang-3stage-x86_64-linux" target="_blank">http://bb.pgr.jp/builders/clang-3stage-x86_64-linux</a><br>
<br>
2013/11/9 NAKAMURA Takumi <<a href="mailto:geek4civic@gmail.com">geek4civic@gmail.com</a>>:<br>
<div class="HOEnZb"><div class="h5">> Author: chapuni<br>
> Date: Fri Nov 8 21:54:05 2013<br>
> New Revision: 194314<br>
><br>
> URL: <a href="http://llvm.org/viewvc/llvm-project?rev=194314&view=rev" target="_blank">http://llvm.org/viewvc/llvm-project?rev=194314&view=rev</a><br>
> Log:<br>
> include/llvm/CodeGen/PBQP: Update @param(s) in comments. [-Wdocumentation]<br>
><br>
> Modified:<br>
> llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h<br>
> llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h<br>
> llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h<br>
> llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h<br>
> llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h<br>
><br>
> Modified: llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h<br>
> URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h?rev=194314&r1=194313&r2=194314&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h?rev=194314&r1=194313&r2=194314&view=diff</a><br>
> ==============================================================================<br>
> --- llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h (original)<br>
> +++ llvm/trunk/include/llvm/CodeGen/PBQP/Graph.h Fri Nov 8 21:54:05 2013<br>
> @@ -215,8 +215,8 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Add an edge between the given nodes with the given costs.<br>
> - /// @param n1Itr First node.<br>
> - /// @param n2Itr Second node.<br>
> + /// @param n1Id First node.<br>
> + /// @param n2Id Second node.<br>
> /// @return Edge iterator for the added edge.<br>
> EdgeId addEdge(NodeId n1Id, NodeId n2Id, const Matrix &costs) {<br>
> assert(getNodeCosts(n1Id).getLength() == costs.getRows() &&<br>
> @@ -234,55 +234,55 @@ namespace PBQP {<br>
> unsigned getNumEdges() const { return edges.size() - freeEdges.size(); }<br>
><br>
> /// \brief Get a node's cost vector.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return Node cost vector.<br>
> Vector& getNodeCosts(NodeId nId) { return getNode(nId).getCosts(); }<br>
><br>
> /// \brief Get a node's cost vector (const version).<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return Node cost vector.<br>
> const Vector& getNodeCosts(NodeId nId) const {<br>
> return getNode(nId).getCosts();<br>
> }<br>
><br>
> /// \brief Set a node's data pointer.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @param data Pointer to node data.<br>
> ///<br>
> /// Typically used by a PBQP solver to attach data to aid in solution.<br>
> void setNodeData(NodeId nId, void *data) { getNode(nId).setData(data); }<br>
><br>
> /// \brief Get the node's data pointer.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return Pointer to node data.<br>
> void* getNodeData(NodeId nId) { return getNode(nId).getData(); }<br>
><br>
> /// \brief Get an edge's cost matrix.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return Edge cost matrix.<br>
> Matrix& getEdgeCosts(EdgeId eId) { return getEdge(eId).getCosts(); }<br>
><br>
> /// \brief Get an edge's cost matrix (const version).<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return Edge cost matrix.<br>
> const Matrix& getEdgeCosts(EdgeId eId) const {<br>
> return getEdge(eId).getCosts();<br>
> }<br>
><br>
> /// \brief Set an edge's data pointer.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @param data Pointer to edge data.<br>
> ///<br>
> /// Typically used by a PBQP solver to attach data to aid in solution.<br>
> void setEdgeData(EdgeId eId, void *data) { getEdge(eId).setData(data); }<br>
><br>
> /// \brief Get an edge's data pointer.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return Pointer to edge data.<br>
> void* getEdgeData(EdgeId eId) { return getEdge(eId).getData(); }<br>
><br>
> /// \brief Get a node's degree.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return The degree of the node.<br>
> unsigned getNodeDegree(NodeId nId) const {<br>
> return getNode(nId).getDegree();<br>
> @@ -301,36 +301,36 @@ namespace PBQP {<br>
> EdgeItr edgesEnd() const { return EdgeItr(edges.size(), *this); }<br>
><br>
> /// \brief Get begin iterator for adjacent edge set.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return Begin iterator for the set of edges connected to the given node.<br>
> AdjEdgeItr adjEdgesBegin(NodeId nId) {<br>
> return getNode(nId).edgesBegin();<br>
> }<br>
><br>
> /// \brief Get end iterator for adjacent edge set.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return End iterator for the set of edges connected to the given node.<br>
> AdjEdgeItr adjEdgesEnd(NodeId nId) {<br>
> return getNode(nId).edgesEnd();<br>
> }<br>
><br>
> /// \brief Get the first node connected to this edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return The first node connected to the given edge.<br>
> NodeId getEdgeNode1(EdgeId eId) {<br>
> return getEdge(eId).getNode1();<br>
> }<br>
><br>
> /// \brief Get the second node connected to this edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return The second node connected to the given edge.<br>
> NodeId getEdgeNode2(EdgeId eId) {<br>
> return getEdge(eId).getNode2();<br>
> }<br>
><br>
> /// \brief Get the "other" node connected to this edge.<br>
> - /// @param eItr Edge iterator.<br>
> - /// @param nItr Node iterator for the "given" node.<br>
> + /// @param eId Edge id.<br>
> + /// @param nId Node id for the "given" node.<br>
> /// @return The iterator for the "other" node connected to this edge.<br>
> NodeId getEdgeOtherNode(EdgeId eId, NodeId nId) {<br>
> EdgeEntry &e = getEdge(eId);<br>
> @@ -361,7 +361,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Remove a node from the graph.<br>
> - /// @param nItr Node id.<br>
> + /// @param nId Node id.<br>
> void removeNode(NodeId nId) {<br>
> NodeEntry &n = getNode(nId);<br>
> for (AdjEdgeItr itr = n.edgesBegin(), end = n.edgesEnd(); itr != end; ++itr) {<br>
> @@ -372,7 +372,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Remove an edge from the graph.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> void removeEdge(EdgeId eId) {<br>
> EdgeEntry &e = getEdge(eId);<br>
> NodeEntry &n1 = getNode(e.getNode1());<br>
><br>
> Modified: llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h<br>
> URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h?rev=194314&r1=194313&r2=194314&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h?rev=194314&r1=194313&r2=194314&view=diff</a><br>
> ==============================================================================<br>
> --- llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h (original)<br>
> +++ llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicBase.h Fri Nov 8 21:54:05 2013<br>
> @@ -113,7 +113,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Add the given node to the list of nodes to be optimally reduced.<br>
> - /// @param nItr Node iterator to be added.<br>
> + /// @param nId Node id to be added.<br>
> ///<br>
> /// You probably don't want to over-ride this, except perhaps to record<br>
> /// statistics before calling this implementation. HeuristicBase relies on<br>
> @@ -184,7 +184,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Add a node to the heuristic reduce list.<br>
> - /// @param nItr Node iterator to add to the heuristic reduce list.<br>
> + /// @param nId Node id to add to the heuristic reduce list.<br>
> void addToHeuristicList(Graph::NodeId nId) {<br>
> llvm_unreachable("Must be implemented in derived class.");<br>
> }<br>
> @@ -199,26 +199,26 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Prepare a change in the costs on the given edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> void preUpdateEdgeCosts(Graph::EdgeId eId) {<br>
> llvm_unreachable("Must be implemented in derived class.");<br>
> }<br>
><br>
> /// \brief Handle the change in the costs on the given edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> void postUpdateEdgeCostts(Graph::EdgeId eId) {<br>
> llvm_unreachable("Must be implemented in derived class.");<br>
> }<br>
><br>
> /// \brief Handle the addition of a new edge into the PBQP graph.<br>
> - /// @param eItr Edge iterator for the added edge.<br>
> + /// @param eId Edge id for the added edge.<br>
> void handleAddEdge(Graph::EdgeId eId) {<br>
> llvm_unreachable("Must be implemented in derived class.");<br>
> }<br>
><br>
> /// \brief Handle disconnection of an edge from a node.<br>
> - /// @param eItr Edge iterator for edge being disconnected.<br>
> - /// @param nItr Node iterator for the node being disconnected from.<br>
> + /// @param eId Edge id for edge being disconnected.<br>
> + /// @param nId Node id for the node being disconnected from.<br>
> ///<br>
> /// Edges are frequently removed due to the removal of a node. This<br>
> /// method allows for the effect to be computed only for the remaining<br>
><br>
> Modified: llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h<br>
> URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h?rev=194314&r1=194313&r2=194314&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h?rev=194314&r1=194313&r2=194314&view=diff</a><br>
> ==============================================================================<br>
> --- llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h (original)<br>
> +++ llvm/trunk/include/llvm/CodeGen/PBQP/HeuristicSolver.h Fri Nov 8 21:54:05 2013<br>
> @@ -125,14 +125,14 @@ namespace PBQP {<br>
> Graph& getGraph() { return g; }<br>
><br>
> /// \brief Get the heuristic data attached to the given node.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return The heuristic data attached to the given node.<br>
> HeuristicNodeData& getHeuristicNodeData(Graph::NodeId nId) {<br>
> return getSolverNodeData(nId).getHeuristicData();<br>
> }<br>
><br>
> /// \brief Get the heuristic data attached to the given edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> /// @return The heuristic data attached to the given node.<br>
> HeuristicEdgeData& getHeuristicEdgeData(Graph::EdgeId eId) {<br>
> return getSolverEdgeData(eId).getHeuristicData();<br>
> @@ -140,7 +140,7 @@ namespace PBQP {<br>
><br>
> /// \brief Begin iterator for the set of edges adjacent to the given node in<br>
> /// the solver graph.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return Begin iterator for the set of edges adjacent to the given node<br>
> /// in the solver graph.<br>
> SolverEdgeItr solverEdgesBegin(Graph::NodeId nId) {<br>
> @@ -149,7 +149,7 @@ namespace PBQP {<br>
><br>
> /// \brief End iterator for the set of edges adjacent to the given node in<br>
> /// the solver graph.<br>
> - /// @param nItr Node iterator.<br>
> + /// @param nId Node id.<br>
> /// @return End iterator for the set of edges adjacent to the given node in<br>
> /// the solver graph.<br>
> SolverEdgeItr solverEdgesEnd(Graph::NodeId nId) {<br>
> @@ -157,7 +157,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Remove a node from the solver graph.<br>
> - /// @param eItr Edge iterator for edge to be removed.<br>
> + /// @param eId Edge id for edge to be removed.<br>
> ///<br>
> /// Does <i>not</i> notify the heuristic of the removal. That should be<br>
> /// done manually if necessary.<br>
> @@ -188,21 +188,21 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Add to the end of the stack.<br>
> - /// @param nItr Node iterator to add to the reduction stack.<br>
> + /// @param nId Node id to add to the reduction stack.<br>
> void pushToStack(Graph::NodeId nId) {<br>
> getSolverNodeData(nId).clearSolverEdges();<br>
> stack.push_back(nId);<br>
> }<br>
><br>
> /// \brief Returns the solver degree of the given node.<br>
> - /// @param nItr Node iterator for which degree is requested.<br>
> + /// @param nId Node id for which degree is requested.<br>
> /// @return Node degree in the <i>solver</i> graph (not the original graph).<br>
> unsigned getSolverDegree(Graph::NodeId nId) {<br>
> return getSolverNodeData(nId).getSolverDegree();<br>
> }<br>
><br>
> /// \brief Set the solution of the given node.<br>
> - /// @param nItr Node iterator to set solution for.<br>
> + /// @param nId Node id to set solution for.<br>
> /// @param selection Selection for node.<br>
> void setSolution(const Graph::NodeId &nId, unsigned selection) {<br>
> s.setSelection(nId, selection);<br>
> @@ -217,7 +217,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Apply rule R0.<br>
> - /// @param nItr Node iterator for node to apply R0 to.<br>
> + /// @param nId Node id for node to apply R0 to.<br>
> ///<br>
> /// Node will be automatically pushed to the solver stack.<br>
> void applyR0(Graph::NodeId nId) {<br>
> @@ -231,7 +231,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Apply rule R1.<br>
> - /// @param xnItr Node iterator for node to apply R1 to.<br>
> + /// @param xnId Node id for node to apply R1 to.<br>
> ///<br>
> /// Node will be automatically pushed to the solver stack.<br>
> void applyR1(Graph::NodeId xnId) {<br>
> @@ -280,7 +280,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Apply rule R2.<br>
> - /// @param xnItr Node iterator for node to apply R2 to.<br>
> + /// @param xnId Node id for node to apply R2 to.<br>
> ///<br>
> /// Node will be automatically pushed to the solver stack.<br>
> void applyR2(Graph::NodeId xnId) {<br>
><br>
> Modified: llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h<br>
> URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h?rev=194314&r1=194313&r2=194314&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h?rev=194314&r1=194313&r2=194314&view=diff</a><br>
> ==============================================================================<br>
> --- llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h (original)<br>
> +++ llvm/trunk/include/llvm/CodeGen/PBQP/Heuristics/Briggs.h Fri Nov 8 21:54:05 2013<br>
> @@ -114,7 +114,7 @@ namespace PBQP {<br>
><br>
> /// \brief Determine whether a node should be reduced using optimal<br>
> /// reduction.<br>
> - /// @param nItr Node iterator to be considered.<br>
> + /// @param nId Node id to be considered.<br>
> /// @return True if the given node should be optimally reduced, false<br>
> /// otherwise.<br>
> ///<br>
> @@ -132,7 +132,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Add a node to the heuristic reduce list.<br>
> - /// @param nItr Node iterator to add to the heuristic reduce list.<br>
> + /// @param nId Node id to add to the heuristic reduce list.<br>
> void addToHeuristicReduceList(Graph::NodeId nId) {<br>
> NodeData &nd = getHeuristicNodeData(nId);<br>
> initializeNode(nId);<br>
> @@ -179,7 +179,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Prepare a change in the costs on the given edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> void preUpdateEdgeCosts(Graph::EdgeId eId) {<br>
> Graph &g = getGraph();<br>
> Graph::NodeId n1Id = g.getEdgeNode1(eId),<br>
> @@ -197,7 +197,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Handle the change in the costs on the given edge.<br>
> - /// @param eItr Edge iterator.<br>
> + /// @param eId Edge id.<br>
> void postUpdateEdgeCosts(Graph::EdgeId eId) {<br>
> // This is effectively the same as adding a new edge now, since<br>
> // we've factored out the costs of the old one.<br>
> @@ -205,7 +205,7 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Handle the addition of a new edge into the PBQP graph.<br>
> - /// @param eItr Edge iterator for the added edge.<br>
> + /// @param eId Edge id for the added edge.<br>
> ///<br>
> /// Updates allocability of any nodes connected by this edge which are<br>
> /// being managed by the heuristic. If allocability changes they are<br>
> @@ -251,8 +251,8 @@ namespace PBQP {<br>
> }<br>
><br>
> /// \brief Handle disconnection of an edge from a node.<br>
> - /// @param eItr Edge iterator for edge being disconnected.<br>
> - /// @param nItr Node iterator for the node being disconnected from.<br>
> + /// @param eId Edge id for edge being disconnected.<br>
> + /// @param nId Node id for the node being disconnected from.<br>
> ///<br>
> /// Updates allocability of the given node and, if appropriate, moves the<br>
> /// node to a new list.<br>
><br>
> Modified: llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h<br>
> URL: <a href="http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h?rev=194314&r1=194313&r2=194314&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h?rev=194314&r1=194313&r2=194314&view=diff</a><br>
> ==============================================================================<br>
> --- llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h (original)<br>
> +++ llvm/trunk/include/llvm/CodeGen/PBQP/Solution.h Fri Nov 8 21:54:05 2013<br>
> @@ -70,15 +70,15 @@ namespace PBQP {<br>
> unsigned numRNReductions() const { return rNReductions; }<br>
><br>
> /// \brief Set the selection for a given node.<br>
> - /// @param nItr Node iterator.<br>
> - /// @param selection Selection for nItr.<br>
> + /// @param nodeId Node id.<br>
> + /// @param selection Selection for nodeId.<br>
> void setSelection(Graph::NodeId nodeId, unsigned selection) {<br>
> selections[nodeId] = selection;<br>
> }<br>
><br>
> /// \brief Get a node's selection.<br>
> - /// @param nItr Node iterator.<br>
> - /// @return The selection for nItr;<br>
> + /// @param nodeId Node id.<br>
> + /// @return The selection for nodeId;<br>
> unsigned getSelection(Graph::NodeId nodeId) const {<br>
> SelectionsMap::const_iterator sItr = selections.find(nodeId);<br>
> assert(sItr != selections.end() && "No selection for node.");<br>
><br>
><br>
> _______________________________________________<br>
> llvm-commits mailing list<br>
> <a href="mailto:llvm-commits@cs.uiuc.edu">llvm-commits@cs.uiuc.edu</a><br>
> <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits</a><br>
</div></div></blockquote></div><br></div>