[create-pull-request] automated change

docs/README.md

@@ -0,0 +1,72 @@
+# Python Documentation
+
+## Classes
+
+**[unsigned_ripple_carry_adder](unsigned_ripple_carry_adder.md)**: 
+
+**[signed_ripple_carry_adder](signed_ripple_carry_adder.md)**: 
+
+**[unsigned_pg_ripple_carry_adder](unsigned_pg_ripple_carry_adder.md)**: 
+
+**[signed_pg_ripple_carry_adder](signed_pg_ripple_carry_adder.md)**: 
+
+**[unsigned_carry_lookahead_adder](unsigned_carry_lookahead_adder.md)**: 
+
+**[signed_carry_lookahead_adder](signed_carry_lookahead_adder.md)**: 
+
+**[unsigned_array_multiplier](unsigned_array_multiplier.md)**: 
+
+**[signed_array_multiplier](signed_array_multiplier.md)**: 
+
+**[unsigned_wallace_multiplier](unsigned_wallace_multiplier.md)**: 
+
+**[signed_wallace_multiplier](signed_wallace_multiplier.md)**: 
+
+**[unsigned_dadda_multiplier](unsigned_dadda_multiplier.md)**: 
+
+**[signed_dadda_multiplier](signed_dadda_multiplier.md)**: 
+
+**[arithmetic_circuit](arithmetic_circuit.md)**: 
+
+**[multiplier_circuit](multiplier_circuit.md)**: 
+
+**[logic_gate](logic_gate.md)**: 
+
+**[inverted_logic_gate](inverted_logic_gate.md)**: 
+
+**[and_gate](and_gate.md)**: 
+
+**[nand_gate](nand_gate.md)**: 
+
+**[or_gate](or_gate.md)**: 
+
+**[nor_gate](nor_gate.md)**: 
+
+**[xor_gate](xor_gate.md)**: 
+
+**[xnor_gate](xnor_gate.md)**: 
+
+**[not_gate](not_gate.md)**: 
+
+**[wire](wire.md)**: 
+
+**[bus](bus.md)**: 
+
+**[two_input_one_bit_circuit](two_input_one_bit_circuit.md)**: 
+
+**[three_input_one_bit_circuit](three_input_one_bit_circuit.md)**: 
+
+**[half_adder](half_adder.md)**: 
+
+**[pg_logic_block](pg_logic_block.md)**: 
+
+**[constant_wire_value_0](constant_wire_value_0.md)**: 
+
+**[constant_wire_value_1](constant_wire_value_1.md)**: 
+
+**[full_adder](full_adder.md)**: 
+
+**[full_adder_pg](full_adder_pg.md)**: 
+
+
+## Functions

docs/and_gate.md

@@ -0,0 +1,39 @@
+# and_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/arithmetic_circuit.md

@@ -0,0 +1,883 @@
+# arithmetic_circuit
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### add_component
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+component |  | 
+
+
+
+
+
+### get_previous_component
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+number |  | 1
+
+
+
+
+
+### get_instance_num
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+cls |  | 
+
+
+
+
+
+### get_unique_one_bit_components
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_unique_multi_bit_components
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_unique_types
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+components |  | 
+
+
+
+
+
+### get_component_types
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_sum_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_carry_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_circuit_wires
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_circuit_wire_index
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+wire |  | 
+
+
+
+
+
+### get_circuit_gates
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_cgp_wires
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_includes_c
+
+
+
+
+
+
+
+### get_prototype_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declarations_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_inits_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_c_code_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_blocks_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_block_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_declaration_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_out_invocation_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+circuit_prefix |  | 
+
+
+
+
+
+### get_function_out_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_circuit_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_c_code_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_prototype_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declarations_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_inits_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_v_code_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_blocks_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_block_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_declaration_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+circuit_prefix |  | 
+
+
+
+
+
+### get_function_out_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_circuit_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_v_code_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_prototype_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_blif_code_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+circuit_prefix |  | 
+
+
+
+
+
+### get_circuit_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_blocks_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_block_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_blif_code_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_parameters_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_triplet_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_output_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_cgp_code
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+

docs/bus.md

@@ -0,0 +1,187 @@
+# bus
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+prefix |  | 
+N |  | 1
+wires_list |  | None
+
+
+
+
+
+### connect
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+out_wire_index |  | 
+inner_component_out_wire |  | 
+
+
+
+
+
+### get_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+wire_index |  | 0
+
+
+
+
+
+### bus_extend
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+N |  | 
+prefix |  | "bus"
+
+
+
+
+
+### get_declaration_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_declaration_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_assign_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+bus_prefix |  | ""
+
+
+
+
+
+### return_wire_value_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+offset |  | 0
+
+
+
+
+
+### get_wire_declaration_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_assign_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+bus_prefix |  | ""
+
+
+
+
+
+### get_wire_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_assign_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+output |  | False
+
+
+
+

docs/constant_wire_value_0.md

@@ -0,0 +1,24 @@
+# constant_wire_value_0
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "constant_wire_value_0"
+
+
+
+

docs/constant_wire_value_1.md

@@ -0,0 +1,24 @@
+# constant_wire_value_1
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "constant_wire_value_1"
+
+
+
+

docs/full_adder.md

@@ -0,0 +1,25 @@
+# full_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+c |  | 
+prefix |  | "fa"
+
+
+
+

docs/full_adder_pg.md

@@ -0,0 +1,67 @@
+# full_adder_pg
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+c |  | 
+prefix |  | "fa_cla"
+
+
+
+
+
+### get_propagate_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_generate_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_sum_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/half_adder.md

@@ -0,0 +1,24 @@
+# half_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "ha"
+
+
+
+

docs/inverted_logic_gate.md

@@ -0,0 +1,66 @@
+# inverted_logic_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "gate"
+
+
+
+
+
+### get_function_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/logic_gate.md

@@ -0,0 +1,416 @@
+# logic_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "gate"
+
+
+
+
+
+### get_component_types
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_includes_c
+
+
+
+
+
+
+
+### get_prototype_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_assign_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_c_code
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_block_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_gate_invocation_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+remove_prefix |  | True
+
+
+
+
+
+### get_gate_output_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+offset |  | 0
+
+
+
+
+
+### get_prototype_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_assign_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_v_code
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_block_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_gate_invocation_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+remove_prefix |  | True
+
+
+
+
+
+### get_prototype_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_blif_code
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_block_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+init |  | False
+
+
+
+
+
+### get_parameters_cgp
+
+
+
+
+
+
+
+### get_triplet_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a_index |  | 0
+b_index |  | 1
+
+
+
+
+
+### get_output_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+out_index |  | 2
+
+
+
+
+
+### get_cgp_code
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+

docs/multiplier_circuit.md

@@ -0,0 +1,149 @@
+# multiplier_circuit
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_previous_partial_product
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a_index |  | 
+b_index |  | 
+offset |  | 0
+
+
+
+
+
+### get_maximum_height
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+initial_value |  | 
+
+
+
+
+
+### init_column_heights
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+signed |  | False
+
+
+
+
+
+### add_column_wires
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+column |  | 
+column_index |  | 
+
+
+
+
+
+### get_column_height
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+column_num |  | 
+
+
+
+
+
+### update_column_heights
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+curr_column |  | 
+curr_height_change |  | 
+next_column |  | 0
+next_height_change |  | 0
+
+
+
+
+
+### get_column_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+column |  | 
+bit |  | 
+
+
+
+
+
+### update_column_wires
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+curr_column |  | 
+adder |  | 
+next_column |  | 0
+
+
+
+

docs/nand_gate.md

@@ -0,0 +1,39 @@
+# nand_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/nor_gate.md

@@ -0,0 +1,39 @@
+# nor_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/not_gate.md

@@ -0,0 +1,282 @@
+# not_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_prototype_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_assign_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_gate_invocation_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+remove_prefix |  | True
+
+
+
+
+
+### get_gate_output_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+offset |  | 0
+
+
+
+
+
+### get_prototype_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_assign_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_gate_invocation_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+remove_prefix |  | True
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+init |  | False
+
+
+
+
+
+### get_triplet_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a_index |  | 0
+
+
+
+
+
+### get_output_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+out_index |  | 1
+
+
+
+

docs/or_gate.md

@@ -0,0 +1,39 @@
+# or_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/pg_logic_block.md

@@ -0,0 +1,66 @@
+# pg_logic_block
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "pg_logic"
+
+
+
+
+
+### get_propagate_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_generate_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_sum_wire
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/signed_array_multiplier.md

@@ -0,0 +1,24 @@
+# signed_array_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_arrmul"
+
+
+
+

docs/signed_carry_lookahead_adder.md

@@ -0,0 +1,24 @@
+# signed_carry_lookahead_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_cla"
+
+
+
+

docs/signed_dadda_multiplier.md

@@ -0,0 +1,25 @@
+# signed_dadda_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_dadda_rca"
+unsigned_adder_class_name |  | 
+
+
+
+

docs/signed_pg_ripple_carry_adder.md

@@ -0,0 +1,24 @@
+# signed_pg_ripple_carry_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_pg_rca"
+
+
+
+

docs/signed_ripple_carry_adder.md

@@ -0,0 +1,24 @@
+# signed_ripple_carry_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_rca"
+
+
+
+

docs/signed_wallace_multiplier.md

@@ -0,0 +1,25 @@
+# signed_wallace_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "s_wallace_rca"
+unsigned_adder_class_name |  | 
+
+
+
+

docs/three_input_one_bit_circuit.md

@@ -0,0 +1,119 @@
+# three_input_one_bit_circuit
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_prototype_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_out_invocation_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_prototype_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_parameters_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/two_input_one_bit_circuit.md

@@ -0,0 +1,401 @@
+# two_input_one_bit_circuit
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_c_code_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_block_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_declaration_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_out_invocation_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_c_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_prototype_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_v_code_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+file_object |  | 
+
+
+
+
+
+### get_function_block_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_declaration_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_init_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_v_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_mapping_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_out_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_block_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_invocation_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_function_blif_hier
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_parameters_cgp
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/unsigned_array_multiplier.md

@@ -0,0 +1,24 @@
+# unsigned_array_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_arrmul"
+
+
+
+

docs/unsigned_carry_lookahead_adder.md

@@ -0,0 +1,24 @@
+# unsigned_carry_lookahead_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_cla"
+
+
+
+

docs/unsigned_dadda_multiplier.md

@@ -0,0 +1,25 @@
+# unsigned_dadda_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_dadda_rca"
+unsigned_adder_class_name |  | 
+
+
+
+

docs/unsigned_pg_ripple_carry_adder.md

@@ -0,0 +1,24 @@
+# unsigned_pg_ripple_carry_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_pg_rca"
+
+
+
+

docs/unsigned_ripple_carry_adder.md

@@ -0,0 +1,24 @@
+# unsigned_ripple_carry_adder
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_rca"
+
+
+
+

docs/unsigned_wallace_multiplier.md

@@ -0,0 +1,25 @@
+# unsigned_wallace_multiplier
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | "u_wallace_rca"
+unsigned_adder_class_name |  | 
+
+
+
+

docs/wire.md

@@ -0,0 +1,148 @@
+# wire
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | 
+value |  | 0
+index |  | 0
+
+
+
+
+
+### get_declaration_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_wire_value_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | ""
+offset |  | 0
+
+
+
+
+
+### get_assign_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | 
+
+
+
+
+
+### return_wire_value_c
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+offset |  | 0
+
+
+
+
+
+### get_declaration_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+
+
+### get_assign_v
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | 
+offset |  | 0
+array |  | False
+
+
+
+
+
+### get_declaration_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | ""
+offset |  | 0
+array |  | False
+
+
+
+
+
+### get_assign_blif
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+name |  | 
+output |  | False
+
+
+
+

docs/xnor_gate.md

@@ -0,0 +1,39 @@
+# xnor_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+

docs/xor_gate.md

@@ -0,0 +1,39 @@
+# xor_gate
+
+
+
+
+## Methods
+
+
+### __init__
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+a |  | 
+b |  | 
+prefix |  | ""
+outid |  | 0
+
+
+
+
+
+### get_function_blif_flat
+
+
+
+
+#### Parameters
+name | description | default
+--- | --- | ---
+self |  | 
+
+
+
+