Algoritmalar ve kaynak kod listeleri

Sözde kod için algorithm2e taslağı, gerçek kod için listings.

Algoritmalar ve kaynak kod listeleri

Makaleler kodu iki ayrı biçimde sunar ve LaTeX’in her biri için ayrı bir aracı vardır. Sözde kod, bir algoritmanın anahtar sözcükler ve matematikle dizilmiş idealleştirilmiş bir taslağıdır; onu algorithm2e paketi halleder. Kaynak kod listeleri ise gerçek kodun sabit aralıklı bir yazı tipiyle olduğu gibi basılmasıdır; onları listings paketi halleder. Yanlış aracı seçmek sürtünmenin olağan kaynağıdır, bu yüzden ikisini de görmek işe yarar.

algorithm2e ile sözde kod

\usepackage[ruled,vlined]{algorithm2e}
\begin{algorithm}
\caption{Train}
\While{not converged}{
Update $\theta$\;
}
\end{algorithm}

Paket seçenekleri görsel biçemi belirler: ruled, algoritmanın üstüne ve altına yatay çizgiler çeker ve başlığı üste koyar, çoğu yayın yerinin beklediği gelenek budur; vlined ise her bloğun kapsamını gösteren küçük bir dikey çizgi çizer, böylece iç içe yapı ağır girintiler olmadan okunabilir kalır. algorithm ortamı bir şekil gibi bir kayan nesnedir, bu yüzden \ref komutunun atıf yapabilmesi için ona numara veren \caption komutunu taşır.

İçeride \While{condition}{body} döngüyü kalın bir anahtar sözcük, koşul ve girintili bir blok olarak gövdeyle dizer. \For, \If ve \Return aynı kalıbı izler. İfadeler, satırın sonlandırıcısını basan ve yeni bir satır başlatan \; ile biter. Onu unutmak klasik acemi hatasıdır: satırlar birbirine karışır. Bu sıradan LaTeX olduğu için $\theta$ gibi matematik satır içinde çalışır; sözde kodun amacı da budur: güncelleme kuralını belirli bir dil yerine gösterimle anlatmak.

listings ile gerçek kod

\usepackage{listings}
\begin{lstlisting}[language=Python]
def f(x):
return x**2
\end{lstlisting}

lstlisting ortamı içeriğini olduğu gibi yeniden üretir, boşlukları korur ve özel karakterlere düz karakter gibi davranır; böylece hiçbir şeyi kaçışlamadan kodu yapıştırabilirsiniz. language=Python seçeneği o dil için anahtar sözcük vurgulamayı açar ve listings onlarca başka dili tanır. Varsayılan olarak çıktı sadedir. Çoğu kişi, makul boyutta sabit aralıklı bir yazı tipini satır numaralarıyla elde etmek için önsöze bir kereliğine \lstset{basicstyle=\ttfamily\small, numbers=left} ekler. Yapıştırmak yerine bir dosyayı doğrudan dahil etmek için \lstinputlisting[language=Python]{train.py} onu diskten okur ve makaleyi gerçek kaynakla eşzamanlı tutar. Renkli, yüksek kaliteli vurgulama istiyorsanız minted paketi daha güçlü bir alternatiftir; bunun bedeli, harici bir araç ve kabuk kaçışı (shell escape) gerektirmesidir.

Aralarından seçmek

Fikri aktarmak için makale gövdesinde sözde kod kullanın; birebir listeleri ise tam kodun önemli olduğu ekler veya araç açıklamaları gibi yerlere saklayın. Sık yapılan bir hata, bir Beamer çerçevesinin içine [fragile] seçeneği olmadan lstlisting koymaktır; bu, anlaşılmaz bir hatayla sonuçlanır. Aynı uyarı ilk Beamer sunumu dersinde de geçer.

Alan kitleri bölümüne geri dön