From 6abf71276427cd45d7278dd7972a92e6e9828353 Mon Sep 17 00:00:00 2001 From: Valentin Boettcher Date: Fri, 10 Mar 2023 10:34:11 -0500 Subject: [PATCH] some documentation tweaks --- src/FloquetUtils.jl | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/FloquetUtils.jl b/src/FloquetUtils.jl index ad2ca3f..5457b5c 100644 --- a/src/FloquetUtils.jl +++ b/src/FloquetUtils.jl @@ -1,3 +1,9 @@ +""" +This is a loose collection to naively calculate the time evolution +operator and Floquet Hamiltonian for a given time dependent +Hamiltonian `H(t)`. +""" + module FloquetUtils import LinearAlgebra: I, eigvecs, eigen, Diagonal @@ -31,7 +37,7 @@ end """ - floquet_hamiltonian(U, T) + floquet_hamiltonian(U::Matrix, T) Returns the Floquet Hamiltonian given a unitary matrix `U` and a time `T`. @@ -43,11 +49,11 @@ end """ - floquet_hamiltonian(H(t), T) + floquet_hamiltonian(H::Function, T) Returns the Floquet Hamiltonian given a Hamiltionian `H` and a time `T`. The rest arguments are passed on to -`DifferentialEquations.solve`. +[`DifferentialEquations.solve`](@ref). """ function floquet_hamiltonian(H::Function, T::Real, args...; kwargs...) U = time_evolution_op(H, T, args...; kwargs...)