[Format] Rename .clang_format to .clang-format to enable it (quantum-compiler#136)

* Add .clang-format

* Restore some options

* Restore some more options

* code format

* restore template option

* adjust penalties

* change include order and pack constructor settings

* align escaped new lines

* allow single-line templates

* code format

Author: xumingkuan

.clang_format .clang-format

@@ -8,22 +8,23 @@ AlignConsecutiveMacros: None
 AlignConsecutiveAssignments: None
 AlignConsecutiveBitFields: None
 AlignConsecutiveDeclarations: None
-AlignEscapedNewlines: Left
+AlignEscapedNewlines: Right
 AlignOperands:   Align
 AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
 AllowShortEnumsOnASingleLine: true
 AllowShortBlocksOnASingleLine: Never
 AllowShortCaseLabelsOnASingleLine: false
 AllowShortFunctionsOnASingleLine: All
 AllowShortLambdasOnASingleLine: All
-AllowShortIfStatementsOnASingleLine: WithoutElse
-AllowShortLoopsOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
-AlwaysBreakBeforeMultilineStrings: true
-AlwaysBreakTemplateDeclarations: Yes
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
 AttributeMacros:
   - __capability
 BinPackArguments: true
@@ -61,6 +62,7 @@ ColumnLimit:     80
 CommentPragmas:  '^ IWYU pragma:'
 QualifierAlignment: Leave
 CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
 ConstructorInitializerIndentWidth: 4
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true
@@ -70,44 +72,41 @@ DisableFormat:   false
 EmptyLineAfterAccessModifier: Never
 EmptyLineBeforeAccessModifier: LogicalBlock
 ExperimentalAutoDetectBinPacking: false
-PackConstructorInitializers: NextLine
-BasedOnStyle:    ''
-ConstructorInitializerAllOnOneLineOrOnePerLine: false
-AllowAllConstructorInitializersOnNextLine: true
 FixNamespaceComments: true
 ForEachMacros:
   - foreach
   - Q_FOREACH
   - BOOST_FOREACH
 IfMacros:
   - KJ_IF_MAYBE
-IncludeBlocks:   Regroup
+IncludeBlocks:   Preserve  # Regroup
 IncludeCategories:
   - Regex:           '^<ext/.*\.h>'
     Priority:        2
     SortPriority:    0
-    CaseSensitive:   false
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
   - Regex:           '^<.*\.h>'
     Priority:        1
     SortPriority:    0
-    CaseSensitive:   false
   - Regex:           '^<.*'
     Priority:        2
     SortPriority:    0
-    CaseSensitive:   false
   - Regex:           '.*'
     Priority:        3
     SortPriority:    0
-    CaseSensitive:   false
 IncludeIsMainRegex: '([-_](test|unittest))?$'
 IncludeIsMainSourceRegex: ''
 IndentAccessModifiers: false
-IndentCaseLabels: true
+IndentCaseLabels: false
 IndentCaseBlocks: false
 IndentGotoLabels: true
 IndentPPDirectives: None
 IndentExternBlock: AfterExternBlock
-IndentRequires:  false
 IndentWidth:     2
 IndentWrappedFunctionNames: false
 InsertTrailingCommas: None
@@ -124,18 +123,18 @@ ObjCBlockIndentWidth: 2
 ObjCBreakBeforeNestedBlockParam: true
 ObjCSpaceAfterProperty: false
 ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: BinPack
 PenaltyBreakAssignment: 2
-PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakBeforeFirstCallParameter: 19
 PenaltyBreakComment: 300
 PenaltyBreakFirstLessLess: 120
 PenaltyBreakOpenParenthesis: 0
 PenaltyBreakString: 1000
 PenaltyBreakTemplateDeclaration: 10
 PenaltyExcessCharacter: 1000000
-PenaltyReturnTypeOnItsOwnLine: 200
-PenaltyIndentedWhitespace: 0
-PointerAlignment: Left
-PPIndentWidth:   -1
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+PPIndentWidth: -1
 RawStringFormats:
   - Language:        Cpp
     Delimiters:
@@ -195,7 +194,7 @@ SpaceAroundPointerQualifiers: Default
 SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyBlock: false
 SpaceInEmptyParentheses: false
-SpacesBeforeTrailingComments: 2
+SpacesBeforeTrailingComments: 1  # 2
 SpacesInAngles:  Never
 SpacesInConditionalStatement: false
 SpacesInContainerLiterals: true

.gitignore

@@ -48,9 +48,6 @@ Makefile
 # Dataset
 *.json
 
-# Clang format
-.clang-format
-
 # Cython
 python/quartz/_cython/*.cpp
 python/build/*

src/benchmark/dp.cpp

@@ -41,7 +41,8 @@ int main() {
   }
   std::vector<int> num_local_qubits = {28};
   KernelCost kernel_cost(
-      /*fusion_kernel_costs=*/{0, 6.4, 6.2, 6.5, 6.4, 6.4, 25.8, 32.4},
+      /*fusion_kernel_costs=*/
+      {0, 6.4, 6.2, 6.5, 6.4, 6.4, 25.8, 32.4},
       /*shared_memory_init_cost=*/6,
       /*shared_memory_gate_cost=*/
       [](quartz::GateType type) {

src/benchmark/nam_middle_circuits.cpp

@@ -1,6 +1,7 @@
 #include "quartz/parser/qasm_parser.h"
 #include "quartz/tasograph/substitution.h"
 #include "test/gen_ecc_set.h"
+
 #include <cmath>
 #include <filesystem>
 #include <sstream>

src/quartz/circuitseq/circuitgate.h

@@ -15,7 +15,7 @@ class Context;
  * Stores the gate type, input and output information.
  */
 class CircuitGate {
-public:
+ public:
   // Get the minimum qubit index of the gate.
   [[nodiscard]] int get_min_qubit_index() const;
   // Get the qubit indices of the gate.

src/quartz/circuitseq/circuitseq.cpp

@@ -722,11 +722,11 @@ CircuitSeqHashType CircuitSeq::hash(Context *ctx) {
     for (int i = 0; i < num_total_params; i++) {
       const auto &param = all_parameters[i];
       ComplexType shifted =
-          dot_product * ComplexType{std::cos(param), std::sin(param)};
+          dot_product * (ComplexType{std::cos(param), std::sin(param)});
       generate_hash_values(ctx, shifted, i, all_parameters, &tmp,
                            &other_hash_values_);
       other_hash_values_.emplace_back(tmp, i);
-      shifted = dot_product * ComplexType{std::cos(param), -std::sin(param)};
+      shifted = dot_product * (ComplexType{std::cos(param), -std::sin(param)});
       generate_hash_values(ctx, shifted, i + num_total_params, all_parameters,
                            &tmp, &other_hash_values_);
       other_hash_values_.emplace_back(tmp, i + num_total_params);
@@ -735,8 +735,8 @@ CircuitSeqHashType CircuitSeq::hash(Context *ctx) {
       // Check phase shift of pi/4, 2pi/4, ..., 7pi/4.
       for (int i = 1; i < 8; i++) {
         const double pi = std::acos(-1.0);
-        ComplexType shifted = dot_product * ComplexType{std::cos(pi / 4 * i),
-                                                        std::sin(pi / 4 * i)};
+        ComplexType shifted = dot_product * (ComplexType{std::cos(pi / 4 * i),
+                                                         std::sin(pi / 4 * i)});
         generate_hash_values(ctx, shifted, i, all_parameters, &tmp,
                              &other_hash_values_);
         other_hash_values_.emplace_back(tmp,
@@ -1227,7 +1227,7 @@ bool CircuitSeq::canonical_representation(
   }
 
   class CompareByMinQubitIndex {
-  public:
+   public:
     bool operator()(CircuitGate *gate1, CircuitGate *gate2) const {
       // std::priority_queue maintains the largest element,
       // so we use ">" to get the gate with minimum qubit index.

src/quartz/circuitseq/circuitseq.h

@@ -16,7 +16,7 @@ namespace quartz {
 class Context;
 
 class CircuitSeq {
-public:
+ public:
   // TODO: Input parameters should be handled in Context instead of here
   CircuitSeq(int num_qubits, int num_input_parameters);
   CircuitSeq(const CircuitSeq &other); // clone a CircuitSeq
@@ -212,7 +212,7 @@ class CircuitSeq {
 
   static bool same_gate(CircuitGate *gate1, CircuitGate *gate2);
 
-private:
+ private:
   void clone_from(const CircuitSeq &other,
                   const std::vector<int> &qubit_permutation,
                   const std::vector<int> &param_permutation);
@@ -243,13 +243,13 @@ class CircuitSeq {
       const std::vector<ParamType> &param_values, CircuitSeqHashType *main_hash,
       std::vector<std::pair<CircuitSeqHashType, PhaseShiftIdType>> *other_hash);
 
-public:
+ public:
   std::vector<std::unique_ptr<CircuitWire>> wires;
   std::vector<std::unique_ptr<CircuitGate>> gates;
   std::vector<CircuitWire *> outputs;
   std::vector<CircuitWire *> parameters;
 
-private:
+ private:
   int num_qubits, num_input_parameters;
   CircuitSeqHashType hash_value_;
   // For both floating-point error tolerance
@@ -271,7 +271,7 @@ class CircuitSeq {
 };
 
 class UniquePtrCircuitSeqComparator {
-public:
+ public:
   bool operator()(const std::unique_ptr<CircuitSeq> &seq1,
                   const std::unique_ptr<CircuitSeq> &seq2) const {
     if (!seq1 || !seq2) {

src/quartz/circuitseq/circuitwire.h

@@ -11,7 +11,7 @@ class CircuitGate;
  * Can be a qubit or a parameter (see comment below).
  */
 class CircuitWire {
-public:
+ public:
   enum Type {
     internal_qubit,
     input_qubit,

src/quartz/context/context.h

@@ -15,7 +15,7 @@ namespace quartz {
 class CircuitSeq;
 
 class Context {
-public:
+ public:
   explicit Context(const std::vector<GateType> &supported_gates);
   Context(const std::vector<GateType> &supported_gates, const int num_qubits,
           const int num_params);
@@ -62,7 +62,7 @@ class Context {
   // ranging [0, 1].
   double random_number();
 
-private:
+ private:
   bool insert_gate(GateType tp);
 
   size_t global_unique_id;

src/quartz/context/rule_parser.h

@@ -13,7 +13,7 @@
 namespace quartz {
 
 class Command {
-public:
+ public:
   Command() {}
   Command(const Command &cmd) {
     tp = cmd.tp;
@@ -77,7 +77,7 @@ class Command {
 };
 
 class RuleParser {
-public:
+ public:
   RuleParser(std::vector<std::string> rules_) {
     for (auto rule : rules_) {
       std::string gate_name;
@@ -151,7 +151,7 @@ class RuleParser {
     return false;
   }
 
-public:
+ public:
   static std::pair<RuleParser *, RuleParser *> ccz_cx_rz_rules() {
     RuleParser *rule_0 =
         new RuleParser({"ccz q0 q1 q2 = cx q1 q2; rz q2 -0.25pi; cx q0 q2; rz "
@@ -194,7 +194,7 @@ class RuleParser {
     return std::make_pair(rule_0, rule_1);
   }
 
-private:
+ private:
   std::map<GateType,
            std::vector<std::pair<
                Command, std::pair<std::vector<Command>, std::set<GateType>>>>>

src/quartz/dataset/dataset.h

@@ -8,7 +8,7 @@
 namespace quartz {
 
 class Dataset {
-public:
+ public:
   bool save_json(Context *ctx, const std::string &file_name) const;
 
   // Return the number of DAGs removed.

src/quartz/dataset/equivalence_set.h

@@ -15,7 +15,7 @@ namespace quartz {
 class EquivalenceSet;
 
 class EquivalenceClass {
-public:
+ public:
   // Returns all DAGs in this equivalence class.
   [[nodiscard]] std::vector<CircuitSeq *> get_all_dags() const;
 
@@ -68,12 +68,12 @@ class EquivalenceClass {
   static bool less_than(const EquivalenceClass &ecc1,
                         const EquivalenceClass &ecc2);
 
-private:
+ private:
   std::vector<std::unique_ptr<CircuitSeq>> dags_;
 };
 
 class UniquePtrEquivalenceClassComparator {
-public:
+ public:
   bool operator()(const std::unique_ptr<EquivalenceClass> &ecc1,
                   const std::unique_ptr<EquivalenceClass> &ecc2) const {
     if (!ecc1 || !ecc2) {
@@ -86,7 +86,7 @@ class UniquePtrEquivalenceClassComparator {
 
 // This class stores all equivalence classes.
 class EquivalenceSet {
-public:
+ public:
   // |new_representatives| is for Generator::generate().
   // It will be pushed back all representatives previously not in
   // the equivalence set.
@@ -180,7 +180,7 @@ class EquivalenceSet {
   [[nodiscard]] std::vector<EquivalenceClass *>
   get_containing_class(Context *ctx, CircuitSeq *dag) const;
 
-private:
+ private:
   void set_possible_class(const CircuitSeqHashType &hash_value,
                           EquivalenceClass *equiv_class);
   void remove_possible_class(const CircuitSeqHashType &hash_value,

src/quartz/dataset/representative_set.h

@@ -6,7 +6,7 @@
 namespace quartz {
 
 class RepresentativeSet {
-public:
+ public:
   bool load_json(Context *ctx, const std::string &file_name);
 
   bool save_json(const std::string &file_name) const;
@@ -31,7 +31,7 @@ class RepresentativeSet {
   // Sort the circuits in this equivalence class by CircuitSeq::less_than().
   void sort();
 
-private:
+ private:
   std::vector<std::unique_ptr<CircuitSeq>> dags_;
 };
 

src/quartz/gate/add.h

@@ -6,7 +6,7 @@
 
 namespace quartz {
 class AddGate : public Gate {
-public:
+ public:
   AddGate() : Gate(GateType::add, 0 /*num_qubits*/, 2 /*num_parameters*/) {}
   ParamType compute(const std::vector<ParamType> &input_params) override {
     assert(input_params.size() == 2);

src/quartz/gate/ccx.h

@@ -6,7 +6,7 @@
 
 namespace quartz {
 class CCXGate : public Gate {
-public:
+ public:
   CCXGate()
       : Gate(GateType::ccx, 3 /*num_qubits*/, 0 /*num_parameters*/),
         mat({{1, 0, 0, 0, 0, 0, 0, 0},

src/quartz/gate/ccz.h

@@ -6,7 +6,7 @@
 
 namespace quartz {
 class CCZGate : public Gate {
-public:
+ public:
   CCZGate()
       : Gate(GateType::ccz, 3 /*num_qubits*/, 0 /*num_parameters*/),
         mat({{1, 0, 0, 0, 0, 0, 0, 0},