Gerektiğinde bir çözüme nasıl ulaştığına ilişkin bir açıklama veren algoritma modeli

Aşağıdaki senaryo bana birkaç kez oldu.

Belli bir sorunu çözen bir algoritma programladım. İyi çalışır ve doğru çözümleri bulur. Şimdi, algoritmaya "çözüme nasıl ulaştığınıza dair tam bir açıklama yazın" deme bir seçeneğim var. Amacım, çevrimiçi gösterilerde, öğretici sınıflarda vb. Kullanılacak iyi bir tasarım deseni nedir?

ÖRNEK: En büyük ortak böleni bulmak için bu yöntemi uyguladığımı varsayalım . Geçerli uygulanan yöntem, doğru bir yanıt verir, ancak açıklama içermez. Yöntem gibi eylemlerini açıklamak için bir seçenek var istiyorum:

Initially, a=6 and b=4. The number of 2-factors, d, is initialized to 0.
a and b are both even, so we divide them by 2 and increment d by 1.
Now, a=3 and b=2.
a is odd but b is even, so we divide b by 2.
Now, a=3 and b=1.
a and b are both odd, so we replace a by (a-b)/2 = 1.
Now, a=1 and b=1.
a=b, so the GCD is a*2^d = 2.

Çıktı, hem konsolda hem de web tabanlı uygulamalarda kolayca görüntülenebilecek şekilde döndürülmelidir.

Açıklama gerekmediğinde algoritmanın gerçek zamanlı performansını etkilemeden, gerektiğinde açıklama sağlamak için iyi bir model nedir?

Aradığınız "kalıp", "günlük" olarak adlandırılır, günlük ifadelerini ihtiyacınız olduğu kadar ayrıntılı yapın. İyi bir günlük kaydı çerçevesi kullanarak, çalışma zamanında açıp kapatabilmeli, farklı ayrıntı düzeyi sağlayabilmeli veya çıktıyı farklı amaçlara (web ve konsol gibi) göre ayarlayabilmelisiniz.

Bunun kayda değer bir performans etkisi varsa (günlük kaydı kapalı olsa bile) büyük olasılıkla dile, çerçeveye ve belirli bir durumda ihtiyacınız olan günlük kaydı ifadelerinin sayısına bağlı olacaktır. Derlenmiş dillerde, bu gerçekten bir sorun haline gelirse, kodunuzun "günlüğe kaydetme varyantını" ve "günlüğe kaydetmeyen varyantını" oluşturmak için bir derleyici anahtarı sağlayabilirsiniz. Ancak, ilk önce ölçüm yapmadan "her ihtimale karşı" optimizasyona karşı şiddetle tavsiye ederim.

İyi bir model Gözlemci'dir. https://en.wikipedia.org/wiki/Observer_pattern

Algoritmanızda, bir şey çıkarmak istediğiniz her noktada, bazı gözlemcilere bildirirsiniz. Daha sonra, metninizi konsolda çıktılamak veya HTML motoruna / Apache'ye göndermek için ne yapacaklarına karar verirler.

Programlama dilinize bağlı olarak, onu hızlı hale getirmenin farklı yolları olabilir. Örneğin, Java'da (kısalık için sahte kod olarak kabul edin; alıcılar, ayarlayıcılar ile "doğru" yapmak okuyucuya bırakılır):

interface AlgoLogObserver {
   public void observe(String message);
}

class AlgorithmXyz {   
   AlgoLogObserver observer = null;
   void runCalculation() {   
       if (observer!=null) { oberserver.observe("Hello"); }
       ...
   }   
}

...
algo = new AlgorithmXyz();
algo.observer = new ConsoleLoggingObserver();  // yes, yes make a 
                                               // setter instead, or use Ruby :-)
algo.runCalculation();

Bu biraz ayrıntılı, ancak kontrol ==nullolabildiğince hızlı olmalıdır.

(Not genel durumda olduğunu observermuhtemelen olurdu Vector observersyerine birden fazla gözlemci için izin vermek; bu sıra elbette ki mümkündür ve daha havai yol açmayacak; Yine ayarladığınız optimizasyonu koyabilirsiniz observers=nullbir kalmadan boş Vector.)

Elbette, neyi başarmak istediğinize bağlı olarak farklı türden gözlemciler uygularsınız. Ayrıca zamanlama istatistiklerini vb. Koyabilir veya başka süslü şeyler yapabilirsiniz.

Düz günlüğe kaydetmede küçük bir iyileştirme olarak, algoritmanın bir yürütülmesini modelleyen bir tür nesne oluşturun. Kodunuz her ilginç şey yaptığında bu kapsayıcı nesnesine bir "adım" ekleyin. Algoritmanın sonunda, biriken adımları kaptan günlüğe kaydedin.

Bunun birkaç avantajı vardır:

1. Tam yürütmeyi tek bir günlük girişi olarak kaydedebilirsiniz, genellikle diğer iş parçacıklarının algo adımlarınız arasında bir şeyler kaydetme olasılığı olduğunda yararlıdır
2. Bu sınıfın Java sürümünde (yalnızca "Hata Ayıklama" olarak adlandırılır), günlük girişleri olarak dizeler eklemezim , ancak dizeler üreten lambdalar eklerim . Bu lambda'lar yalnızca gerçek günlük kaydı gerçekleşirse, örneğin Debug nesnesi günlük düzeyinin şu anda etkin olduğunu tespit ederse değerlendirilir. Bu şekilde, günlük dizelerini gereksiz yere oluşturmanın performans yükü ortadan kalkar.

DÜZENLEME: Başkaları tarafından yorumlandığı gibi, lambdaların ek yükü vardır, bu nedenle bu ek yükün günlük dizesini oluşturmak için gereken kodun gereksiz değerlendirmesinden daha az olduğundan emin olmak için karşılaştırmanız gerekir (günlük girişleri genellikle basit değişmez değerler değildir, ancak katılan nesneler).

Genellikle dallanma ararım, yani if-ifadeleri ararım. Çünkü bunlar bir değeri değerlendirdiğimi gösterir, bu algoritmanın akışını kontrol eder. Bu gibi her durumda (her koşul), seçilen yolu ve neden seçildiğini kaydedebilirim.

Bu yüzden temelde giriş değerlerini (başlangıç ​​durumu), seçilen her dalı (koşullu) ve seçilen dalı (geçici durum) girerken değerleri kaydederim.