필요할 때 솔루션에 도달하는 방법에 대한 설명을 출력하는 알고리즘 패턴

다음 시나리오는 여러 번 발생했습니다.

특정 문제를 해결하는 알고리즘을 프로그래밍했습니다. 제대로 작동하고 올바른 솔루션을 찾습니다. 이제 알고리즘에 "솔루션을 얻는 방법에 대한 자세한 설명을 작성하십시오"라고 알리는 옵션이 필요합니다. 내 목표는 온라인 데모, 자습서 클래스 등에서 알고리즘을 사용할 수 있도록하는 것입니다. 설명 없이도 실시간으로 알고리즘을 실행할 수있는 옵션이 필요합니다. 좋은 디자인 패턴은 무엇입니까?

예 : 최대 공약수를 구하기 위해이 방법을 구현한다고 가정 합니다. 현재 구현 된 메소드는 정답을 리턴하지만 설명은 없습니다. 메소드가 다음과 같이 조치를 설명하는 옵션을 갖고 싶습니다.

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.

콘솔과 웹 기반 응용 프로그램 모두에 쉽게 표시 될 수 있도록 출력을 반환해야합니다.

설명이 필요하지 않을 때 알고리즘의 실시간 성능을 손상시키지 않으면 서 필요한 경우 설명을 제공하는 좋은 패턴은 무엇입니까?

찾고있는 "패턴"을 "로깅"이라고합니다. 로깅 문장을 필요한만큼 자세하게 작성하면됩니다. 적절한 로깅 프레임 워크를 사용하면 런타임에이를 켜거나 끄고, 다양한 상세 레벨을 제공하거나, 다른 목적 (예 : 웹과 콘솔)에 맞게 출력을 조정할 수 있어야합니다.

이것이 현저한 성능 영향을 미치는 경우 (로깅이 해제 된 경우에도) 언어, 프레임 워크 및 특정 경우에 필요한 로깅 문의 수에 따라 달라질 수 있습니다. 컴파일 된 언어에서 이것이 실제로 문제가되는 경우 코드의 "로깅 변형"및 "비 로깅 변형"을 빌드하기 위해 컴파일러 스위치를 제공 할 수 있습니다. 그러나 먼저 측정하지 않고 "경우에 따라"최적화하지 않는 것이 좋습니다.

좋은 패턴은 관찰자입니다. https://ko.wikipedia.org/wiki/Observer_pattern

알고리즘에서 무언가를 출력하려는 ​​각 지점에서 관찰자에게 알립니다. 그런 다음 콘솔에서 텍스트를 출력하거나 HTML 엔진 / 아파치 등에 전송할 작업을 결정합니다.

프로그래밍 언어에 따라 빠르게 만드는 다른 방법이있을 수 있습니다. 예를 들어, Java에서는 (간결성을 위해 의사 코드로 처리하십시오. getter, setter와 함께 "올바르게"만드는 것은 독자에게 맡겨져 있습니다) :

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();

이것은 약간 장황하지만 확인하는 ==null것이 가능한 한 빠릅니다.

(주 일반적인 경우에, 것을 observer아마 될 것 Vector observers대신에 하나 이상의 관찰자 수 있도록, 이것은뿐만 아니라 물론 가능하며 더 많은 오버 헤드로 이어질하지 않습니다, 당신은 아직도 당신이 설정하는 것이 최적화에 넣을 수 있습니다 observers=null을하는 대신 비어 Vector있습니다.)

물론 달성하려는 목표에 따라 다양한 종류의 관찰자를 구현해야합니다. 거기에 타이밍 통계 등을 넣거나 다른 멋진 일을 할 수도 있습니다.

스트레이트 로깅의 약간의 개선으로, 한 번의 알고리즘 실행을 모델링하는 일종의 오브젝트를 작성하십시오. 코드가 흥미로운 일을 할 때마다이 컨테이너 객체에 "단계"를 추가하십시오. 알고리즘이 끝나면 컨테이너에서 누적 된 단계를 기록하십시오.

몇 가지 장점이 있습니다.

1. 전체 실행을 하나의 로그 항목 으로 기록 할 수 있으며 , 다른 스레드가 알고리즘 단계 사이에 물건을 기록 할 가능성이있을 때 유용합니다.
2. 이 클래스의 Java 버전 (단순히 "Debug"라고 함)에서 문자열 을 로그 항목으로 추가하지 않고 문자열 을 생성하는 람다 를 추가 합니다 . 이러한 람다는 실제 로깅이 발생하는 경우, 즉 디버그 개체가 로그 수준이 현재 활성화되어있는 것으로 확인 된 경우에만 평가됩니다. 이렇게하면 불필요하게 로그 문자열을 구성 할 때 성능 오버 헤드가 발생하지 않습니다.

편집 : 다른 사람들이 언급했듯이 람다는 오버 헤드가 있으므로이 오버 헤드가 로그 문자열을 구성하는 데 필요한 코드의 불필요한 평가보다 적은지 벤치 마크해야합니다 (로그 항목은 종종 단순한 리터럴이 아니지만 컨텍스트 정보를 얻는 것과 관련이 있습니다) 참여 대상).

나는 보통 분기를 찾습니다. 즉, if 문을 찾습니다. 이것들은 내가 값을 평가한다는 것을 나타내므로 알고리즘의 흐름을 제어합니다. 이러한 각 발생 (각 조건)에서 선택한 경로와 선택한 이유를 기록 할 수 있습니다.

따라서 기본적으로 항목 값 (초기 상태), 선택한 모든 분기 (조건부) 및 선택한 분기 (임시 상태)를 입력 할 때의 값을 기록합니다.