Merge pull request #95 from kzrnm/release/v3.0.0-atcoder1

v3.0.0-atcoder1
kzrnm · Jan 24, 2023 · 4bf949a · 4bf949a
2 parents 834b7bb + 771d07a
commit 4bf949a
Show file tree

Hide file tree

Showing 13 changed files with 144 additions and 84 deletions.
diff --git a/.github/workflows/build-release-publish.yml b/.github/workflows/build-release-publish.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - release/atcoder
     tags:
       - "v[0-9]+.[0-9]+.[0-9]+*"
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0-pre1] - 2023-01-24
+- Rename assembly from AtCoderLibrary to ac-library-csharp
+- Rename some methods/classes to PascalCase
+
+## [3.0.0-atcoder1] - 2023-01-24
+- Make SourceExpander.Embedder switchable
+- Disable some Contract.Assert
+
 ## [2.1.1] - 2023-01-17
 - Optimize PrimitiveRoot
 

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -7,15 +7,18 @@
     <RepositoryUrl>https://github.com/kzrnm/ac-library-csharp</RepositoryUrl>
     <PackageReleaseNotes>https://github.com/kzrnm/ac-library-csharp/blob/main/CHANGELOG.md</PackageReleaseNotes>
 
-    <Version>2.1.1</Version>
-    <AssemblyVersion>2.1.1.101</AssemblyVersion>
+    <Version>3.0.0-atcoder1</Version>
+    <AssemblyVersion>3.0.0.1</AssemblyVersion>
     <RepositoryCommit Condition="'$(GIT_COMMIT)' != ''">$(GIT_COMMIT)</RepositoryCommit>
 
     <SignAssembly>True</SignAssembly>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)key.snk</AssemblyOriginatorKeyFile>
 
     <PackageOutputPath>$(MSBuildThisFileDirectory)bin\Packages\$(Configuration)\</PackageOutputPath>
 
+    <EmbeddingSource>false</EmbeddingSource>
+    <DefineConstants Condition="'$(EmbeddingSource)'=='true'">$(DefineConstants);EMBEDDING</DefineConstants>
+
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>

diff --git a/Source/AtCoderAnalyzer/AnalyzerReleases.Shipped.md b/Source/AtCoderAnalyzer/AnalyzerReleases.Shipped.md
@@ -28,11 +28,3 @@ AC0003 | Type Define | Error | Not defined IStaticMod
 AC0004 | Type Define | Error | Not defined IDynamicModID
 AC0005 | Type Define | Error | Not defined ISegtreeOperator<T>
 AC0006 | Type Define | Error | Not defined ILazySegtreeOperator<T, F>
-
-## Release 1.10.0
-
-### Changed Rules
-
-Rule ID | Category | Severity | Notes
---------|----------|----------|--------------------
-AC0007 | Type Define | Info | Operator method doesn't have `MethodImpl(AggressiveInlining)` attribute
diff --git a/Source/AtCoderAnalyzer/AtCoderAnalyzer.csproj b/Source/AtCoderAnalyzer/AtCoderAnalyzer.csproj
@@ -9,6 +9,7 @@
     <Description>Analyzer For AtCoder library</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <NoWarn>$(NoWarn);CS1998</NoWarn>
+    <IsPackable>false</IsPackable>
   </PropertyGroup>
   <PropertyGroup>
     <IsRoslynComponent>true</IsRoslynComponent>

diff --git a/Source/AtCoderAnalyzer/Diagnostics/DiagnosticDescriptors.cs b/Source/AtCoderAnalyzer/Diagnostics/DiagnosticDescriptors.cs
@@ -5,9 +5,10 @@ namespace AtCoderAnalyzer.Diagnostics
 {
     public static class DiagnosticDescriptors
     {
+#pragma warning disable IDE0090 // Avoid 'new(...)' for Shipped.md
         internal static Diagnostic AC0001_MultiplyOverflowInt32(SyntaxNode node)
             => Diagnostic.Create(AC0001_MultiplyOverflowInt32_Descriptor, node.GetLocation(), node.ToString());
-        internal static readonly DiagnosticDescriptor AC0001_MultiplyOverflowInt32_Descriptor = new(
+        internal static readonly DiagnosticDescriptor AC0001_MultiplyOverflowInt32_Descriptor = new DiagnosticDescriptor(
             "AC0001",
             new LocalizableResourceString(
                 nameof(DiagnosticsResources.AC0001_Title),
@@ -23,7 +24,7 @@ internal static Diagnostic AC0001_MultiplyOverflowInt32(SyntaxNode node)
             );
         internal static Diagnostic AC0002_LeftShiftOverflowInt32(SyntaxNode node)
             => Diagnostic.Create(AC0002_LeftShiftOverflowInt32_Descriptor, node.GetLocation(), node.ToString());
-        internal static readonly DiagnosticDescriptor AC0002_LeftShiftOverflowInt32_Descriptor = new(
+        internal static readonly DiagnosticDescriptor AC0002_LeftShiftOverflowInt32_Descriptor = new DiagnosticDescriptor(
             "AC0002",
             new LocalizableResourceString(
                 nameof(DiagnosticsResources.AC0002_Title),
@@ -40,7 +41,8 @@ internal static Diagnostic AC0002_LeftShiftOverflowInt32(SyntaxNode node)
 
         internal static Diagnostic AC0007_AgressiveInlining(Location location, IEnumerable<string> methods)
             => Diagnostic.Create(AC0007_AgressiveInlining_Descriptor, location, string.Join(", ", methods));
-        internal static readonly DiagnosticDescriptor AC0007_AgressiveInlining_Descriptor = new(
+
+        internal static readonly DiagnosticDescriptor AC0007_AgressiveInlining_Descriptor = new DiagnosticDescriptor(
             "AC0007",
             new LocalizableResourceString(
                 nameof(DiagnosticsResources.AC0007_Title),
@@ -57,7 +59,7 @@ internal static Diagnostic AC0007_AgressiveInlining(Location location, IEnumerab
 
         internal static Diagnostic AC0008_DefineOperatorType(Location location, IEnumerable<string> types)
             => Diagnostic.Create(AC0008_DefineOperatorType_Descriptor, location, string.Join(", ", types));
-        internal static readonly DiagnosticDescriptor AC0008_DefineOperatorType_Descriptor = new(
+        internal static readonly DiagnosticDescriptor AC0008_DefineOperatorType_Descriptor = new DiagnosticDescriptor(
             "AC0008",
             new LocalizableResourceString(
                 nameof(DiagnosticsResources.AC0008_Title),
@@ -71,5 +73,6 @@ internal static Diagnostic AC0008_DefineOperatorType(Location location, IEnumera
             DiagnosticSeverity.Error,
             isEnabledByDefault: true
             );
+#pragma warning restore IDE0090
     }
 }
diff --git a/Source/ac-library-csharp/Internal/InternalBit.cs b/Source/ac-library-csharp/Internal/InternalBit.cs
@@ -37,7 +37,9 @@ public static uint ExtractLowestSetBit(int n)
         [MethodImpl(256)]
         public static int Bsf(uint n)
         {
-            //Contract.Assert(n > 0, reason: $"{nameof(n)} must positive");
+#if EMBEDDING
+            Contract.Assert(n > 0, reason: $"{nameof(n)} must positive");
+#endif
             return BitOperations.TrailingZeroCount(n);
         }
 

diff --git a/Source/ac-library-csharp/Math/DynamicModInt.cs b/Source/ac-library-csharp/Math/DynamicModInt.cs
@@ -1,8 +1,10 @@
 using System;
-using System.Globalization;
-using System.Numerics;
 using System.Runtime.CompilerServices;
 using AtCoder.Internal;
+#if GENERIC_MATH
+using System.Globalization;
+using System.Numerics;
+#endif
 
 namespace AtCoder
 {
@@ -88,8 +90,10 @@ public static int Mod
         public static DynamicModInt<T> Raw(int v)
         {
             var u = unchecked((uint)v);
-            //Contract.Assert(bt != null, $"{nameof(DynamicModInt<T>)}<{nameof(T)}>.{nameof(Mod)} is undefined.");
-            //Contract.Assert(u < Mod, $"{nameof(u)} must be less than {nameof(Mod)}.");
+#if EMBEDDING
+            Contract.Assert(bt != null, $"{nameof(DynamicModInt<T>)}<{nameof(T)}>.{nameof(Mod)} is undefined.");
+            Contract.Assert(u < Mod, $"{nameof(u)} must be less than {nameof(Mod)}.");
+#endif
             return new DynamicModInt<T>(u);
         }
 

diff --git a/Source/ac-library-csharp/Math/StaticModInt.cs b/Source/ac-library-csharp/Math/StaticModInt.cs
@@ -1,8 +1,10 @@
 using System;
-using System.Globalization;
-using System.Numerics;
 using System.Runtime.CompilerServices;
 using AtCoder.Internal;
+#if GENERIC_MATH
+using System.Globalization;
+using System.Numerics;
+#endif
 
 namespace AtCoder
 {
@@ -92,7 +94,9 @@ public readonly struct StaticModInt<T>
         public static StaticModInt<T> Raw(int v)
         {
             var u = unchecked((uint)v);
-            //Contract.Assert(u < Mod, $"{nameof(u)} must be less than {nameof(Mod)}.");
+#if EMBEDDING
+            Contract.Assert(u < Mod, $"{nameof(u)} must be less than {nameof(Mod)}.");
+#endif
             return new StaticModInt<T>(u);
         }
 

diff --git a/Source/ac-library-csharp/String/StringLib.cs b/Source/ac-library-csharp/String/StringLib.cs
@@ -151,7 +151,9 @@ static int[] CreateIdx<T>(ReadOnlySpan<T> m)
         public static int[] SuffixArray(int[] s, int upper)
         {
             Contract.Assert(0 <= upper, reason: $"{nameof(upper)} must be positive.");
-            //Contract.Assert(s.All(si => (uint)si <= (uint)upper), reason: $"si ∈ {nameof(s)} must be 0 <= si && si <= {nameof(upper)}");
+#if EMBEDDING
+            Contract.Assert(s.All(si => (uint)si <= (uint)upper), reason: $"si ∈ {nameof(s)} must be 0 <= si && si <= {nameof(upper)}");
+#endif
             return InternalString.SaIs(s, upper);
         }
         #endregion SuffixArray
@@ -387,6 +389,7 @@ public static int[] SaIs(ReadOnlySpan<int> s, int upper, int thresholdNaive, int
                 Induce(lms, s, sa, ls, sumS, sumL);
 
                 // LMSを再帰的にソート
+                // m の値は再帰ごとに半分以下になるので再帰の回数も log(n) に抑えられる
                 if (m > 0)
                 {
                     var sortedLms = new SimpleList<int>(m);

diff --git a/Source/ac-library-csharp/ac-library-csharp.csproj b/Source/ac-library-csharp/ac-library-csharp.csproj
@@ -1,69 +1,69 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-	<PropertyGroup>
-		<TargetFrameworks>net7.0;netcoreapp3.1;netstandard2.1</TargetFrameworks>
-		<RootNamespace>AtCoder</RootNamespace>
-		<OutputType>Library</OutputType>
+  <PropertyGroup>
+    <TargetFrameworks>net7.0;netcoreapp3.1;netstandard2.1</TargetFrameworks>
+    <RootNamespace>AtCoder</RootNamespace>
+    <OutputType>Library</OutputType>
 
-		<LangVersion Condition="'$(TargetFramework)' == 'netstandard2.1'">7.3</LangVersion>
-		<LangVersion Condition="'$(TargetFramework)' == 'netcoreapp3.1'">8</LangVersion>
-		<LangVersion Condition="'$(TargetFramework)' == 'net7.0'">11</LangVersion>
+    <LangVersion Condition="'$(TargetFramework)' == 'netstandard2.1'">7.3</LangVersion>
+    <LangVersion Condition="'$(TargetFramework)' == 'netcoreapp3.1'">8</LangVersion>
+    <LangVersion Condition="'$(TargetFramework)' == 'net7.0'">11</LangVersion>
 
-		<AllowUnsafeBlocks>false</AllowUnsafeBlocks>
+    <AllowUnsafeBlocks>false</AllowUnsafeBlocks>
 
-		<PackageTags>ac-library-csharp;AtCoder</PackageTags>
-		<PackageId>ac-library-csharp</PackageId>
-		<Description>C# port of ac-library</Description>
-		<GenerateDocumentationFile>true</GenerateDocumentationFile>
-		<GeneratePackageOnBuild Condition="'$(Configuration)' == 'Release'">true</GeneratePackageOnBuild>
+    <PackageTags>ac-library-csharp;AtCoder</PackageTags>
+    <PackageId>ac-library-csharp</PackageId>
+    <Description>C# port of ac-library</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <GeneratePackageOnBuild Condition="'$(Configuration)' == 'Release'">true</GeneratePackageOnBuild>
 
-		<NoWarn>$(NoWarn);CS1574;CA1034;CS1591;CS1734;IDE0039;IDE0057</NoWarn>
+    <NoWarn>$(NoWarn);CS1574;CA1034;CS1591;CS1734;IDE0039;IDE0057</NoWarn>
 
-		<PackageLicenseExpression></PackageLicenseExpression>
-		<PackageLicenseFile>LICENSE</PackageLicenseFile>
+    <PackageLicenseExpression></PackageLicenseExpression>
+    <PackageLicenseFile>LICENSE</PackageLicenseFile>
 
-		<DefineConstants>$(DefineConstants);ATCODER_CONTRACT</DefineConstants>
+    <DefineConstants>$(DefineConstants);ATCODER_CONTRACT</DefineConstants>
 
-		<GenericMath Condition="'$(TargetFramework)'!='netstandard2.1' And '$(TargetFramework)'!='netcoreapp3.1'">true</GenericMath>
-		<DefineConstants Condition="'$(GenericMath)'=='true'">$(DefineConstants);GENERIC_MATH</DefineConstants>
-	</PropertyGroup>
-	<ItemGroup>
-		<InternalsVisibleTo Include="ac-library-csharp.Test, PublicKey=002400000480000094000000060200000024000052534131000400000100010019f27fe0b62f6a374e67a12dbd713e0b521d251abc73fcb1e3929cc74a99905daae786e8854b1ccd7401ecb850627c58ecf491bebe9a2fef9effbc63e74e1c00e036282d754dd6c8ffd12e8fd07897bf31b551f68d594c2bdd5be8009adc6eb625e10629d36d731246a8a9c353b62c49902024cf1c7fc0f59952325eec2df5a6" />
-	</ItemGroup>
+    <GenericMath Condition="'$(TargetFramework)'!='netstandard2.1' And '$(TargetFramework)'!='netcoreapp3.1'">true</GenericMath>
+    <DefineConstants Condition="'$(GenericMath)'=='true'">$(DefineConstants);GENERIC_MATH</DefineConstants>
+  </PropertyGroup>
+  <ItemGroup>
+    <InternalsVisibleTo Include="ac-library-csharp.Test, PublicKey=002400000480000094000000060200000024000052534131000400000100010019f27fe0b62f6a374e67a12dbd713e0b521d251abc73fcb1e3929cc74a99905daae786e8854b1ccd7401ecb850627c58ecf491bebe9a2fef9effbc63e74e1c00e036282d754dd6c8ffd12e8fd07897bf31b551f68d594c2bdd5be8009adc6eb625e10629d36d731246a8a9c353b62c49902024cf1c7fc0f59952325eec2df5a6" />
+  </ItemGroup>
 
-	<ItemGroup Condition="'$(GenericMath)'!='true'">
-		<Compile Remove="**/*GenericMath.cs" />
-		<Compile Remove="**/*GenericMath/**/*.cs" />
-	</ItemGroup>
+  <ItemGroup Condition="'$(GenericMath)'!='true'">
+    <Compile Remove="**/*GenericMath.cs" />
+    <Compile Remove="**/*GenericMath/**/*.cs" />
+  </ItemGroup>
 
-	<ItemGroup>
-		<ProjectReference Include="..\..\Source\AtCoderAnalyzer\AtCoderAnalyzer.csproj">
-			<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
-			<OutputItemType>Analyzer</OutputItemType>
-		</ProjectReference>
-		<PackageReference Include="SourceExpander.Embedder" Version="5.0.0">
-			<PrivateAssets>all</PrivateAssets>
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-		</PackageReference>
-	</ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\Source\AtCoderAnalyzer\AtCoderAnalyzer.csproj">
+      <ReferenceOutputAssembly>false</ReferenceOutputAssembly>
+      <OutputItemType>Analyzer</OutputItemType>
+    </ProjectReference>
+    <PackageReference Include="SourceExpander.Embedder" Version="5.1.0" Condition="'$(EmbeddingSource)'=='true'">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 
-	<ItemGroup>
-		<None Include="LICENSE" Pack="True" PackagePath="" />
-		<None Include="Math\MathLib.Convolution.Primitives.cs">
-			<DesignTime>True</DesignTime>
-			<AutoGen>True</AutoGen>
-			<DependentUpon>MathLib.Convolution.Primitives.tt</DependentUpon>
-		</None>
-		<None Update="Math\MathLib.Convolution.Primitives.tt">
-			<Generator>TextTemplatingFileGenerator</Generator>
-			<LastGenOutput>MathLib.Convolution.Primitives.cs</LastGenOutput>
-		</None>
-		<Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
-		<Compile Update="Math\MathLib.Convolution.Primitives.cs">
-			<DesignTime>True</DesignTime>
-			<AutoGen>True</AutoGen>
-			<DependentUpon>MathLib.Convolution.Primitives.tt</DependentUpon>
-		</Compile>
-	</ItemGroup>
+  <ItemGroup>
+    <None Include="LICENSE" Pack="True" PackagePath="" />
+    <None Include="Math\MathLib.Convolution.Primitives.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>MathLib.Convolution.Primitives.tt</DependentUpon>
+    </None>
+    <None Update="Math\MathLib.Convolution.Primitives.tt">
+      <Generator>TextTemplatingFileGenerator</Generator>
+      <LastGenOutput>MathLib.Convolution.Primitives.cs</LastGenOutput>
+    </None>
+    <Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
+    <Compile Update="Math\MathLib.Convolution.Primitives.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>MathLib.Convolution.Primitives.tt</DependentUpon>
+    </Compile>
+  </ItemGroup>
 
 </Project>
diff --git a/Test/ac-library-csharp.Test/SourceExpanderTest.cs b/Test/ac-library-csharp.Test/SourceExpanderTest.cs
@@ -8,6 +8,13 @@ namespace AtCoder.Embedding
 {
     public class SourceExpanderTest
     {
+        class EmbeddingFact : FactAttribute
+        {
+#if !EMBEDDING
+            public override string Skip => "SourceExpander.Embedder is disabled.";
+#endif
+        }
+
 #if NETCOREAPP3_0
         const bool useIntrinsics = false;
         const string languageVersion = "7.3";
@@ -20,12 +27,24 @@ public class SourceExpanderTest
 #endif
 
         [Fact]
+        public async Task Embedding()
+        {
+            var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
+            embedded.AssemblyMetadatas.Keys.Should()
+#if EMBEDDING
+                .ContainMatch(@"SourceExpander.*");
+#else
+                .NotContainMatch(@"SourceExpander.*");
+#endif
+        }
+
+        [EmbeddingFact]
         public void AssemblyName()
         {
             typeof(Segtree<,>).Assembly.GetName().Name.Should().Be("ac-library-csharp");
         }
 
-        [Fact]
+        [EmbeddingFact]
         public async Task Symbol()
         {
             var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
@@ -41,7 +60,7 @@ public async Task Symbol()
                 .Be(useIntrinsics);
         }
 
-        [Fact]
+        [EmbeddingFact]
         public async Task LanguageVersion()
         {
             var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
@@ -50,7 +69,7 @@ public async Task LanguageVersion()
                 .WhoseValue.Should().Be(languageVersion);
         }
 
-        [Fact]
+        [EmbeddingFact]
         public async Task EmbeddedSource()
         {
             var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
@@ -67,7 +86,7 @@ public async Task EmbeddedSource()
                 "AtCoder.Segtree<TValue, TOp>");
         }
 
-        [Fact]
+        [EmbeddingFact]
         public async Task EmbeddedNamespaces()
         {
             var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
@@ -81,7 +100,7 @@ public async Task EmbeddedNamespaces()
         }
 
 
-        [Fact]
+        [EmbeddingFact]
         public async Task RemoveContract()
         {
             var embedded = await EmbeddedData.LoadFromAssembly(typeof(Segtree<,>));
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ on: @@
       push:
         branches:
           - main
+          - release/atcoder
         tags:
           - "v[0-9]+.[0-9]+.[0-9]+*"
@@ Expand Down @@