X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=a6f4bcac5d53520e810d66b024dfbc73744dd6a1;hb=8c1110db34ac870015cb7edb6e5bba6ca1f2d90d;hp=fc1bd0f712a154c2f325b502951f382b38a3a4c4;hpb=d7465beff921821bf120a25a30a35ef06bddfc0e;p=ypp-sc-tools.main.git diff --git a/yarrg/web/docs b/yarrg/web/docs index fc1bd0f..a6f4bca 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -33,17 +33,17 @@ %doc> -
-Formally, the capacity is a list of terms, all but the first preceded -by one of -, minus, +, -plus. Each term may specify a mass and/or a volume -(separated by a space), as a number followed (without an intervening -space) by a unit (t, kg, kl or -l). Alternatively each term except the first may specify a -percentage, which is applied as a percentage change to the answer from -all the preceding terms. The first term may be a ship name or -abbrevation instead. If the first term specifies only one of mass or -volume, all the subsequent terms may only adjust that same value. +More formally: +
+ capacity-string := [ first-term term* ] + term := ('+' | '-' | 'plus' | 'minus') (value+ | number'%') + value := mass | volume + | integer commodity-name-or-abbreviation + mass := number ('t' | 'kg') + volume := number ('kl' | 'l') + first-term := mass | volume | mass volume | volume mass + | ship-name-or-abbreviation ++ +If the first term specifies only one of mass or volume, all the +subsequent terms may only adjust that same value. -
-Trades whose margin is less than the expected loss are never selected. -For example, if you select 1% loss per league, and plan a voyage of 5 -leagues, then any trade with a margin of less than 5.15% would be -completely excluded (5.15% not 5% because the loss works like compound -interest). Theoretically very profitable trades which are close to -the expected break-even point because of the distance can also be -rejected by the optimiser in favour of shorter distance trades with -theoretically smaller margins. +Trades whose margin is less than the expected loss are never included +in the suggested plan. For example, if you select 1% loss per league, +and plan a voyage of 5 leagues, then any trade with a margin of less +than 5.15% would be completely excluded (5.15% not 5% because the loss +works like compound interest). Theoretically very profitable trades +which are close to the expected break-even point because of the +distance can also be rejected by the optimiser in favour of shorter +distance trades with theoretically smaller margins, if it's not +possible to do both.
@@ -178,4 +184,22 @@ You can enter the value in the box either as a percentage, or as a fraction 1/divisor, eg 1/200 is the same as 0.5%; in each case it is taken as the loss for each league of the voyage. +
+ +The trading plan does not take into account accumulated profits from +each leg of the journey when applying the available capital +constraint. For example, if you specify a journey from A to B to C +and a capital limit of 10000 PoE, the trading plan will not tell you +to buy 1000 peas at A for 10 PoE each, sail them to B and sell all of +them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and +sail them to C to sell for 20 PoE each even if such a trade would in +fact be possible. In practice this is unlikely to be a problem! + <& footer &>