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