added newReadMes file by roie-d-classiq · Pull Request #1449 · Classiq/classiq-library

roie-d-classiq · 2026-01-21T14:48:01Z

PR Description

Some notes

TomerGoldfriend · 2026-02-17T05:50:21Z

algorithms/amplitude_amplification_and_estimation/readme.md

@@ -0,0 +1,26 @@
+# Amplitude Amplification and Estimation
+
+The directory contains algorithmic variations of the amplitude amplification and estimation algorithm.


The initial description focuses on amplitude amplification and not on estimation.
It is true that they are very related. I think it is OK to mention Grover in this paragraph, although I am not 100% sure if it can be connected to the QSVT and Oblivious usecases.

I suggest:

Mention Grover operator, but as a canonical building block in several methods.

Mention that all of these algorithms are typically quadratic in the number of queries.

Add a sentence about amplitude estimation.

TomerGoldfriend · 2026-02-17T05:51:55Z

algorithms/foundational/readme.md

@@ -0,0 +1,24 @@
+# Foundational
+
+Fundamental quantum algorithms, providing the foundations for future advancements


For the amplitude estimation and amplification you started with: "This directory contains..."
I would be consistent with the style.
I prefer this one (in Foundational), but feel free to choose whatever you like.

TomerGoldfriend · 2026-02-17T05:53:26Z

algorithms/foundational/readme.md

+  $f(x) = (a\cdot x) \mod 2$, where $x$ is also a bit string and $\cdot$ denotes the bitwise multiplication.
+  This problem constitutes a specific case of the general hidden-shift problem.
+- **Deutsch Jozsa** - Widely regarded as the first quantum algorithm, it demonstrates an exponential advantage in query
+  complexity over classical approaches. Given oracle access to a Boolean function promised to be either


classical deterministic

TomerGoldfriend · 2026-02-17T05:55:18Z

algorithms/foundational/readme.md

+- **Deutsch Jozsa** - Widely regarded as the first quantum algorithm, it demonstrates an exponential advantage in query
+  complexity over classical approaches. Given oracle access to a Boolean function promised to be either
+  constant or balanced, the algorithm deterministically identifies which case holds using a single query to
+  the function. We define a general quantum algorithm that accepts a quantum predicate as an input parameter


The sentences that follows "We define..." are related to the implementation. Such description does not appear in other examples, so I suggest to remove it.

TomerGoldfriend · 2026-02-17T05:56:08Z

algorithms/foundational/readme.md

+  classical communication to transfer ("teleport") an arbitrary qubit state from one place to another.
+- **Simon** - Given an oracle binary function, satisfying $f(x)=f(y)$ if and only if $y=x\oplus s$ for some secret key $s$, the
+  algorithm recovers $s$. It does so using a number of oracle queries linear in the input size, yielding an exponential
+  improvement in query complexity compared to the best classical approaches. After defining the quantum and classical parts


Also here the last sentence.

TomerGoldfriend · 2026-02-17T05:58:53Z

algorithms/hamiltonian_simulation/readme.md

+- **Hamiltonian simulation guide** - Provides an introduction and overview to standard Hamiltonian simulation methods.
+  The methods are described and implemented utilizing Classiq's built-in functions. First, the product formula
+  based methods, Suzuki-Trotter decomposition and qDrift are introduced and implemented. Following,
+  more advanced block-encoding, as qubitization and quantum singular value decomposition, are presented.


In this notebook that block-encoding-based methods are just mentioned (not implemented). I think the word "presented" might be misleading. You can omit the sentence.

yes, I contemplated on that as well, fixed it.

TomerGoldfriend · 2026-02-17T06:01:04Z

algorithms/number_theory_and_cryptography/readme.md

+- **Hidden shift problem** - Implementation of an algorithm to find the hidden-shift for the family of Boolean bent functions, which
+  are characterized by high non-linearity and a perfectly flat Fourier transform. Given access to queries of a functions $f$,
+  the algorithm finds the shift, a boolean string, which satisfies $f(x) = f(x \oplus s)$. The quantum algorithm provides
+  an exponential separation in query complexity relative to any (even the best) classical algorithm.


I did not understand the "(even the best")

modified it to (including the optimal)

TomerGoldfriend · 2026-02-17T06:03:59Z

algorithms/qml/readme.md

@@ -0,0 +1,26 @@
+# QML


TomerGoldfriend · 2026-02-17T06:06:25Z

algorithms/quantum_differential_equations_solvers/readme.md

@@ -0,0 +1,18 @@
+# Quantum Differential Equation Solvers


TomerGoldfriend · 2026-02-17T13:50:52Z

algorithms/quantum_linear_solvers/readme.md

@@ -0,0 +1,26 @@
+# Quantum Linear Solvers


TomerGoldfriend · 2026-02-17T13:52:05Z

algorithms/quantum_phase_estimation/readme.md

@@ -0,0 +1,17 @@
+# Quantum Phase Estimation (QPE)


TomerGoldfriend · 2026-02-17T14:29:43Z

algorithms/quantum_state_preparation/readme.md

@@ -0,0 +1,21 @@
+# Quantum State Preparation


TomerGoldfriend · 2026-02-17T14:32:22Z

algorithms/quantum_walks/readme.md

@@ -0,0 +1,7 @@
+# Quantum Walks/Glued trees
+
+- **Quantum Walks** Demonstrates the encoding of a quantum random walk. The example includes a one-to-one


We do not have a quantum walk in this directory (we have it in the tutorials directory).
Currently, this directory has only the glued trees example, which is related to continuous quantum walk.

deleted this, we can add a readme file when the folder includes more examples

TomerGoldfriend · 2026-02-17T14:35:27Z

algorithms/search_and_optimization/readme.md

+  belonging to a finite field $\mathbb{F}$, and an optimization function, $f(x)$, depending on $B$ and an input vector $x\in \mathbb{F}^n$,
+  the algorithm produces optimal input, maximizing $f$. Shown to give a quantum advantage in Optimal Polynomial Intersection problem.
+  In the present notebook, a simplified version of the problem called max-XORSAT, is utilized to demonstrate the key algorithmic steps.
+- **Grover** - A canonical quantum algorithms, providing the solution of an unstructured search problem.


A canonical quantum algorithm (remove the s).

…thms

github-actions · 2026-02-24T07:46:16Z

🎊 Incredible, @roie-d-classiq! You've merged your 18th PR! 🎯🎊

Your ongoing commitment to classiq-library is truly remarkable. You're a driving force in our community! 🚀
Your contributions are helping to shape the future of quantum computing! What exciting features or improvements do you envision next? 🔮

We are grateful for your dedication! 💫

roie-d-classiq force-pushed the readme branch from 3419aac to c261963 Compare February 16, 2026 09:48

TomerGoldfriend reviewed Feb 17, 2026

View reviewed changes

TomerGoldfriend approved these changes Feb 17, 2026

View reviewed changes

roie-d-classiq force-pushed the readme branch from 33c4245 to 9c8bcb6 Compare February 22, 2026 09:20

TomerGoldfriend approved these changes Feb 23, 2026

View reviewed changes

roie-d-classiq added 15 commits February 24, 2026 09:37

added newReadMes file

d13da74

updated newReadMe

28c300c

updated newReadMe

f0fc05d

updated readme file, completed qml and number theoretic algos

e647b94

updated readme file, completed qml and number theoretic algos

1109b00

completed quantum linear solvers

ea7d550

completed quantum differential equation solvers

5f30644

completed search and optimization, quantum primatives and QPE algori…

db9c376

…thms

completed intros for the folders

a9b3790

completed intros for the folders

80c3c40

added readme files to all the folders

dd3be3b

modified the main readme file

b5106cd

revised the readme file after review

18aebb1

revised the readme file after review

32c44fd

modified qml readme

c0974de

roie-d-classiq force-pushed the readme branch from 8d206d9 to c0974de Compare February 24, 2026 07:41

roie-d-classiq merged commit 2faea81 into main Feb 24, 2026
6 checks passed

roie-d-classiq deleted the readme branch February 24, 2026 07:46

roie-d-classiq temporarily deployed to prod February 24, 2026 07:46 — with GitHub Actions Inactive

roie-d-classiq temporarily deployed to staging February 24, 2026 07:46 — with GitHub Actions Inactive

		@@ -0,0 +1,26 @@
		# Amplitude Amplification and Estimation

		The directory contains algorithmic variations of the amplitude amplification and estimation algorithm.

		@@ -0,0 +1,24 @@
		# Foundational

		Fundamental quantum algorithms, providing the foundations for future advancements

		@@ -0,0 +1,7 @@
		# Quantum Walks/Glued trees

		- Quantum Walks Demonstrates the encoding of a quantum random walk. The example includes a one-to-one

Conversation

roie-d-classiq commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Description

Some notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Feb 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

roie-d-classiq commented Jan 21, 2026 •

edited

Loading