X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=a6f4bcac5d53520e810d66b024dfbc73744dd6a1;hb=8c1110db34ac870015cb7edb6e5bba6ca1f2d90d;hp=2abe504ecf7587e8c7899ad327ae98364670a4a3;hpb=87b0d92e050701753d558e49aaae1d433b546170;p=ypp-sc-tools.main.git diff --git a/yarrg/web/docs b/yarrg/web/docs index 2abe504..a6f4bca 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -33,7 +33,7 @@ %doc> -
-This website documentation page contains information about the -database website which you may not be able to divine from the online -user interface. +Hopefully you will be able to work it without too much help, but this +documentation page contains information about the database website +which you may not be able to divine from the online user interface.
-So you should specify your vessel capacity. Currently you must -specify the actual mass and volume, as two numbers each with units. -The system understands the units t (tonnes), kg, l and kl -(kilolitres). There should be a space between the two limits, and no -space before the unit. +So you should specify your vessel capacity. You can enter things +like: +
+ +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.
@@ -150,6 +181,25 @@ every ten 10-league voyages.
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%. +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 &>