Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Refactor] Rename "DAG" to "CircuitSeq" #60

Open
xumingkuan opened this issue Nov 3, 2022 · 3 comments
Open

[Refactor] Rename "DAG" to "CircuitSeq" #60

xumingkuan opened this issue Nov 3, 2022 · 3 comments

Comments

@xumingkuan
Copy link
Collaborator

xumingkuan commented Nov 3, 2022

The name DAG is a bit confusing in that the term "DAG" is not the best name to describe it. It is actually the "Sequence Representation" in our paper (https://arxiv.org/pdf/2204.09033.pdf, page 4, section 3.1).

I am considering renaming it to CircuitSeq to avoid confusion. Here is the complete renaming plan:

  • DAG -> CircuitSeq
  • DAGNode -> CircuitWire
  • DAGHyperEdge -> CircuitGate (I am not sure if this is clear enough that this is a gate in a circuit and easily distinguishable with the abstract Gate type)
  • DAG::nodes -> CircuitSeq::wires
  • DAG::edges -> CircuitSeq::gates
  • DAGNode::input_edges -> CircuitWire::input_gates
  • DAGNode::output_edges -> CircuitWire::output_gates
  • DAGHyperEdge::input_nodes -> CircuitGate::input_wires
  • DAGHyperEdge::output_nodes -> CircuitGate::output_wires
  • Graph::to_dag -> Graph::to_circuit_sequence

Do you think the new names are clear? Any suggestions are welcome.


Edit after merging #61: the class name is renamed, but there are a lot of variable names still being dag. Help wanted for renaming these to seq :)

@xumingkuan
Copy link
Collaborator Author

If there are no suggestions, I will start refactoring.

@jiazhihao
Copy link
Collaborator

These renames look good to me. We should also rename TASOGraph to Graph, since our current graph implementation is quite different from the original TASOGraph. @zikun-li @Co1lin What do you think?

@xumingkuan
Copy link
Collaborator Author

These renames look good to me. We should also rename TASOGraph to Graph, since our current graph implementation is quite different from the original TASOGraph. @zikun-li @Co1lin What do you think?

I think this is already renamed. But the file name is still tasograph/tasograph.h -- shall we also rename that to graph/graph.h?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants